Sign in

v1

latestOpenAPI 3.1.02026-07-241653251.3 MB
Transfers

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.

post/transfers

Headers

X-SCX-SIGNEDstring required

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

X-SCX-TIMESTAMPstring required
Example:1678901234

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

Request body

from_participant_codestring required

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

from_account_groupstring required

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

from_account_labelstring

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

to_participant_codestring required

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

to_account_groupstring required

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

to_account_labelstring

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

assetstring required

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

amountstring required

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

client_transfer_idstring

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

prefundedboolean

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.

Example request

{
  "from_participant_code": "ABCDEF",
  "from_account_group": "ABCDEF",
  "from_account_label": "general",
  "to_participant_code": "DEMO01",
  "to_account_group": "ABCDEF",
  "to_account_label": "general",
  "asset": "USD",
  "amount": "20.1",
  "client_transfer_id": "e6afed46-301e-46ee-a339-e897e9855c3a"
}

Response

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

Example response

{
  "message": {
    "id": 1152665,
    "created_at": "2026-05-04T11:58:50.115Z",
    "updated_at": "2026-05-04T11:58:50.115Z",
    "status": "approved",
    "from_participant_code": "ABCDEF",
    "from_account_group": "ABCDEF",
    "from_account_label": "general",
    "to_participant_code": "DEMO01",
    "to_account_group": "ABCDEF",
    "to_account_label": "general",
    "asset": "USD",
    "amount": "100.00",
    "client_transfer_id": "e6afed46-301e-46ee-a339-e897e9855c3a",
    "parent_link_id_source": "LINK_SOURCE_PREFUNDED_TRANSFER"
  }
}