Create transfer

post

https://api.cert.zerohash.com/transfers

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

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

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

from_participant_code

string

required

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

from_account_group

string

required

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

from_account_label

string

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

to_participant_code

string

required

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

to_account_group

string

required

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

to_account_label

string

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

asset

string

required

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

amount

string

required

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

client_transfer_id

string

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

prefunded

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

X-SCX-SIGNED

string

required

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

X-SCX-TIMESTAMP

string

required

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

Responses

201Successfully created transfer request. Returns the created resource with generated IDs and timestamps.

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable