Skip to main content
Requires X-Api-Key, X-Api-Secret, and Authorization: Bearer <user-jwt> headers. See Authentication for details.
Transfers funds between two accounts in the ledger. Both accounts must have sufficient balance in the same currency. Use Get balance to retrieve account IDs.

​
Request

POST /api/v1/user/transfer

​
Body

FieldTypeRequiredDescription
fromAccountIdnumberNoSource account ID. If omitted, the user’s primary account is used
toAccountIdnumberYesDestination account ID
amountnumberYesAmount in smallest unit — e.g. 50000 = USD 500.00
descriptionstringYesDescription of the transfer
{
  "fromAccountId": 619,
  "toAccountId": 620,
  "amount": 50000,
  "description": "Service payment"
}

​
Response

201 Created 
{
  "id": 4502,
  "status": "COMPLETED",
  "amount": 50000,
  "description": "Service payment"
}
FieldTypeDescription
idnumberTransaction ID
statusstring"COMPLETED" on success
amountnumberAmount transferred in smallest unit
descriptionstringDescription provided in the request