Account Transfers

Account transfers move funds between your own accounts at Increase (accounting systems often refer to these as Book Transfers). Account Transfers are free and synchronous. Upon creation they create two Transactions, one negative on the originating account and one positive on the destination account (unless the transfer requires approval, in which case the Transactions will be created when the transfer is approved).

Events

Your application can listen to webhooks about this resource. The events about Account Transfers will have the categories "account_transfer.created" or "account_transfer.updated" .

The Account Transfer object

{
  "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"
}

Attributes

account_id

string

The Account from which the transfer originated.

More about Accounts.

amount

integer

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

approval

dictionary

Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

cancellation

dictionary

Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

created_at

string

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

created_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

currency

enum

The ISO 4217 code for the transfer’s currency.

description

string

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_id

string

The destination Account’s identifier.

More about Accounts.

destination_transaction_id

string

Nullable

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

More about Transactions.

string

The Account Transfer’s identifier.

idempotency_key

string

Nullable

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_id

string

Nullable

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.

More about Pending Transactions.

status

enum

The lifecycle status of the transfer.

transaction_id

string

Nullable

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

More about Transactions.

type

string

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

List Account Transfers

curl \
  --url "${INCREASE_URL}/account_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Returns a list response :

{
  "data": [
    { /* Account Transfer object */ },
    { /* Account Transfer object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

account_id

string

Filter Account Transfers to those that originated from the specified Account.

More about Accounts.

idempotency_key

string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

Between 1 and 200 characters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create an Account Transfer

curl -X "POST" \
  --url "${INCREASE_URL}/account_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "amount": 100,
    "description": "Creating liquidity",
    "destination_account_id": "account_uf16sut2ct5bevmq3eh"
  }'

Parameters

account_id

string

Required

The identifier for the originating Account that will send the transfer.

More about Accounts.

amount

integer

Required

The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.

description

string

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.

Between 1 and 200 characters

destination_account_id

string

Required

The identifier for the destination Account that will receive the transfer.

More about Accounts.

require_approval

boolean

Whether the transfer should require explicit approval via the dashboard or API. For more information, see Transfer Approvals.

Retrieve an Account Transfer

curl \
  --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

account_transfer_id

string

Required

The identifier of the Account Transfer.

More about Account Transfers.

Approve an Account Transfer

Approves an Account Transfer in status pending_approval.

curl -X "POST" \
  --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

account_transfer_id

string

Required

The identifier of the Account Transfer to approve.

More about Account Transfers.

Cancel an Account Transfer

Cancels an Account Transfer in status pending_approval.

curl -X "POST" \
  --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

account_transfer_id

string

Required

The identifier of the pending Account Transfer to cancel.

More about Account Transfers.