POST: Transfer
POST /transfers
POST /transfers
Creates new transfer request. Note: you can only submit transfers between your own accounts. To submit transfers on behalf of others, you need the submits_platform_transfers_for
relationship. Transfer requests created through the API go directly into an APPROVED
state.
Request body:
client_transfer_id
Optional unique identifier for the transfer. Note: this must be unique, per platform, per 72 hour period
string
from_participant_code
The source participant for the transfer to, e.g. ABCDEF
string
from_account_group
The source account group for the transfer, e.g. ABCDEF
string
from_account_label
The source account label for the transfer, e.g. general
string
to_participant_code
The destination participant for the transfer, e.g. ABCDEF
string
to_account_group
The destination account group for the transfer, e.g. ABCDEF
string
to_account_label
The destination account label for the transfer, e.g. general
string
asset
The asset code for the request, e.g. e₹
string
amount
The amount or quantity transferred, e.g. 100
string
Sample Response
See GET /transfers for response field descriptions.
Last updated