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.

Body Params

from_participant_code

string

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

from_account_group

string

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

object

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

to_account_group

string

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

The asset code for the withdrawal request, e.g. BTC

amount

string

The amount or quantity transferred, e.g. 100

client_transfer_id

string

A unique identifier for the transfer
Note: this 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.

Headers

X-SCX-SIGNED

string

Defaults to [WEB] auto-generated on fly

Signature for your request.

X-SCX-TIMESTAMP

string

Defaults to [WEB] auto-generated on fly

UNIX timestamp.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200

400Bad Request

403Forbidden

404Not Found

500Internal Server Error

503Service Unavailable