Creating account transfer
POST /api/public/v1/transfers
Creates an instant transfer between two of your accounts in the same currency — between a master account and a subaccount, or between two subaccounts. The transfer produces two account transactions: a debit on the source account and a credit on the destination account.
Headers
Content-Type
application/vnd.api+json
Authorization
Bearer <api_key>
Body
data
object
Request data object.
data.type
string
Resource type. Always transfers.
data.attributes
object
Transfer attributes.
data.attributes.from_account
string
ID of the account to debit.
data.attributes.to_account
string
ID of the account to credit. Must hold the same currency as the source account.
data.attributes.amount
number
Amount to transfer.
data.attributes.currency
string
Transfer currency. Must match the currency of both accounts.
data.attributes.reference
string
Your unique reference for this transfer. Included in downloadable CSV transaction reports.
Request JSON
{
"data": {
"type": "transfers",
"attributes": {
"from_account": "13a85b45-8543-41c7-b963-394d4ea128ae",
"to_account": "dd5016e1-43bb-4be5-b6d6-79e8d0f662b1",
"amount": 10,
"currency": "EUR",
"reference": "c9807056-88da-409e-b628-732adbe76be5"
}
}
}Response
Either the source or destination account does not exist.
Response Body
data.id
string
Transfer ID.
data.type
string
Entity type returned. Always accountTransfers.
data.attributes.reference
string
The reference you supplied in the request.
data.relationships.accountTransactions
array
The two transactions created by the transfer — the debit and the credit. Full entities in included[].
included[].type(accountTransactions)
object
A transaction leg: createdAt and amount (negative on the source account, positive on the destination).
included[].type(accounts)
object
The source and destination accounts, with balances updated to reflect the transfer.
Last updated