Sign in

v1

latestOpenAPI 3.0.02026-07-1491520.4 KB
Transfers

Transfer balance

Transfer balance between a primary account and one of its subaccounts. Note that balance_available_for_transfer = |account_balance - credit_limit| of the source account.

post/{api_key}/balance-transfers

Path parameters

api_keystring required

ID of the primary account

Request body

amountnumber required
fromstring required
referencestring
tostring required

Example request

{
  "from": "7c9738e6",
  "reference": "This gets added to the audit log",
  "to": "ad6dc56f"
}

Response

Balance transfer response

amountnumber

Balance transfer amount

balance_transfer_idstring

Unique balance transfer ID

created_atstring

The date and time when the balance transfer was executed

fromstring

Account the balance is transferred from

referencestring

Reference for the balance transfer

tostring

Account the balance is transferred to

Example response

{
  "amount": 123.45,
  "balance_transfer_id": "07b5-46e1-a527-85530e625800",
  "created_at": "2019-03-02T16:34:49Z",
  "from": "7c9738e6",
  "reference": "This gets added to the audit log",
  "to": "ad6dc56f"
}