v4

OpenAPI 3.1.02026-08-012402353.8 MB

Approve an Account Transfer

Approves an Account Transfer in status pending_approval.

post/account_transfers/{account_transfer_id}/approve

Path parameters

account_transfer_idstring required

The identifier of the Account Transfer to approve.

Response

Account Transfer

account_idstring required

The Account from which the transfer originated.

amountinteger required

The transfer amount in cents. This will always be positive and indicates the amount of money leaving the originating account.

created_atstring date-time required

The ISO 8601 date and time at which the transfer was created.

currency'USD' required

The ISO 4217 code for the transfer's currency.

descriptionstring required

An internal-facing description for the transfer for display in the API and dashboard. This will also show in the description of the created Transactions.

destination_account_idstring required

The destination Account's identifier.

destination_transaction_idstring nullable required

The identifier of the Transaction on the destination Account representing the received funds.

idstring required

The Account Transfer's identifier.

idempotency_keystring nullable required

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

pending_transaction_idstring nullable required

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

status'pending_approval' | 'canceled' | 'complete' required

The lifecycle status of the transfer.

transaction_idstring nullable required

The identifier of the Transaction on the originating account representing the transferred funds.

type'account_transfer' required

A constant representing the object's type. For this resource it will always be account_transfer.

Example response

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "amount": 100,
  "approval": {
    "approved_at": "2020-01-31T23:59:59Z",
    "approved_by": null
  },
  "cancellation": null,
  "created_at": "2020-01-31T23:59:59Z",
  "created_by": {
    "category": "user",
    "user": {
      "email": "user@example.com"
    }
  },
  "currency": "USD",
  "description": "Move money into savings",
  "destination_account_id": "account_uf16sut2ct5bevmq3eh",
  "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4",
  "id": "account_transfer_7k9qe1ysdgqztnt63l7n",
  "idempotency_key": null,
  "pending_transaction_id": null,
  "status": "complete",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "account_transfer"
}