Create transfer

Create a new transfer request between your own accounts.
To submit transfers on behalf of others, you will require the submits_platform_transfers_for relationship. Transfer requests created via the API are automatically set to an APPROVED state.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body containing the transfer details including sender, recipient, asset, and amount.

string
required

The source participant for the transfer, e.g. ABCDEF.

string
required

The source account group for the transfer, e.g. ABCDEF.

string

The source account label for the transfer, e.g. general.

string
required

The destination participant for the transfer, e.g. ABCDEF.

string
required

The destination account group for the transfer, e.g. ABCDEF.

string

The destination account label for the transfer, e.g. general.

string
required

The asset code for the transfer, e.g. USD.

string
required

The amount or quantity to transfer, e.g. 100.

string

A unique identifier for the transfer. Must be unique per platform, per 72 hour period.

boolean

Set to true if the transfer amount should be included in the net settlement calculation. Requires pt_1.is_prefunded_transfer_enabled to be enabled for the calling participant.

Headers
string
required

HMAC-SHA256 signature of the request, base64-encoded. See the Authentication guide for the exact signing formula.

string
required

Current Unix timestamp in seconds. Must be within 60 seconds of server time or the request is rejected.

Responses

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