Create an Account Transfer

v1.0.0

Input

{
  "type": "object",
  "required": [
    "account_id",
    "amount",
    "description",
    "destination_account_id"
  ],
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The identifier for the account that will send the transfer."
    },
    "amount": {
      "type": "integer",
      "description": "The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents."
    },
    "description": {
      "type": "string",
      "description": "The description you choose to give the transfer."
    },
    "destination_account_id": {
      "type": "string",
      "description": "The identifier for the account that will receive the transfer."
    },
    "require_approval": {
      "type": "boolean",
      "description": "Whether the transfer requires explicit approval via the dashboard or API."
    }
  }
}

Output

{
  "type": "object",
  "description": "Account transfers move funds between your own accounts at Increase.",
  "required": [
    "account_id",
    "amount",
    "approval",
    "cancellation",
    "created_at",
    "currency",
    "description",
    "destination_account_id",
    "destination_transaction_id",
    "id",
    "network",
    "status",
    "template_id",
    "transaction_id",
    "type"
  ],
  "properties": {
    "account_id": {
      "type": "string",
      "description": "The Account to which the transfer belongs."
    },
    "amount": {
      "type": "integer",
      "description": "The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents."
    },
    "approval": {
      "type": "object",
      "description": "If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.",
      "required": [
        "approved_at"
      ],
      "properties": {
        "approved_at": {
          "type": "string",
          "format": "date-time",
          "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved."
        }
      }
    },
    "cancellation": {
      "type": "object",
      "description": "If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.",
      "required": [
        "canceled_at"
      ],
      "properties": {
        "canceled_at": {
          "type": "string",
          "format": "date-time",
          "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled."
        }
      }
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "description": "The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created."
    },
    "currency": {
      "type": "string",
      "description": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.",
      "enum": [
        "CAD",
        "CHF",
        "EUR",
        "GBP",
        "JPY",
        "USD"
      ]
    },
    "description": {
      "type": "string",
      "description": "The description that will show on the transactions."
    },
    "destination_account_id": {
      "type": "string",
      "description": "The destination account's identifier."
    },
    "destination_transaction_id": {
      "type": "string",
      "description": "The ID for the transaction receiving the transfer."
    },
    "id": {
      "type": "string",
      "description": "The account transfer's identifier."
    },
    "network": {
      "type": "string",
      "description": "The transfer's network.",
      "enum": [
        "account"
      ]
    },
    "status": {
      "type": "string",
      "description": "The lifecycle status of the transfer.",
      "enum": [
        "pending_submission",
        "pending_approval",
        "canceled",
        "requires_attention",
        "flagged_by_operator",
        "complete"
      ]
    },
    "template_id": {
      "type": "string",
      "description": "If the transfer was created from a template, this will be the template's ID."
    },
    "transaction_id": {
      "type": "string",
      "description": "The ID for the transaction funding the transfer."
    },
    "type": {
      "type": "string",
      "description": "A constant representing the object's type. For this resource it will always be `account_transfer`.",
      "enum": [
        "account_transfer"
      ]
    }
  }
}