Transfer funds between wallets

This POST endpoint transfers funds immediately from a source wallet to a destination wallet.
The source_token must refer to a wallet owned by the authenticated client (either a client wallet token or a user wallet token belonging to the client).
The destination_token can refer to any user wallet in the system, or to another client wallet that is linked to this client (e.g. a subclient or sister-client relationship — transfers to unrelated client wallets are not permitted).
Transfers between wallets of different currencies are supported; an FX exchange rate will be applied automatically.
Transfers are executed immediately upon request and are not reversible.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to false

When true, validates the transfer and returns a quote (including FX rate and fee) without actually moving any funds.

Body Params

Wallet transfer request parameters

Request body for transferring funds between wallets.

string
required

Token representing the source wallet. Must be a wallet owned by the authenticated client (client wallet token or user wallet token belonging to this client).

string
required

Token representing the destination wallet. Can be any user wallet in the system or a linked client wallet (subclient or sister-client). Transfers to unrelated client wallets are not permitted.

number
required

Amount to transfer, denominated in the source wallet's currency.

string

Optional client-provided identifier for this transfer. Useful for idempotency and reconciliation.

string

Optional human-readable note or description for this transfer.

metadata
object

Optional arbitrary key-value metadata to attach to the transfer.

Headers
string

Unique key to prevent duplicate processing

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json