Docs
Guides
Explanatory and how-to content
API Reference
Technical documentation
Changelog
Release notes
Dashboard
Manage your account
Status
Service status
API Reference
Account Transfers

Account transfers move funds between your own accounts at Increase.

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,
  "network": "account",
  "pending_transaction_id": null,
  "status": "complete",
  "transaction_id": "transaction_uyrp7fld2ium70oa7oi",
  "type": "account_transfer"
}
Attributes
account_id
string

The Account to which the transfer belongs.

amount
integer

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

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 destination account currency.

description
string

The description that will show on the transactions.

destination_account_id
string

The destination account's identifier.

destination_transaction_id
string
Nullable

The ID for the transaction receiving the transfer.

id
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.

network
string

The transfer's network.

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.

status
enum

The lifecycle status of the transfer.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

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}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

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

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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 account that will send the transfer.

amount
integer
Required

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

description
string
Required

The description you choose to give the transfer.

200 character maximum
destination_account_id
string
Required

The identifier for the account that will receive the transfer.

require_approval
boolean

Whether the transfer requires explicit approval via the dashboard or API.

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.

Approve an Account Transfer
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.

Cancel an Account Transfer
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.

Sandbox: Approve an Account Transfer

If your account is configured to require approval for each transfer, this endpoint simulates the approval of an Account Transfer. You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a status of pending_approval.

curl -X "POST" \
  --url "${INCREASE_URL}/simulations/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/complete" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_transfer_id
string
Required

The identifier of the Account Transfer you wish to complete.