NEnewline53
Combined Transfers

Create a new Combined Transfer

Changed on

Creates a Combined Transfer by simultaneously creating a counterparty Synthetic Account and initiating a Transfer. This streamlines asset movement by reducing the number of steps required to set up and execute a transaction.

post/combined_transfers

Request

Request body

external_uidstring

Optional client-supplied uid

Example request

{
  "external_uid": "YrfDrfVRgpPgnhF5"
}

Response

A single Combined Transfer is returned

created_atstring

Timestamp of when the combined_transfer was created

errorsItems[] (unresolved $ref)

A collection of errors that occured during synthetic account and/or transfer creation. Only displayed if errors were detected.

external_uidExternalUid (unresolved $ref)
status'queued' | 'pending' | 'failed' | 'completed'

The combined transfer's status

synthetic_accountobject

Parameters provided at time of creation. UID field will get populated once synthetic account has been successfully created, unless uid value was supplied at creation time.

transferobject

Parameters provided at time of creation. UID field will get populated once transfer has been successfully initiated.

uidstring

Unique identifier for the Combined Transfer

Changes

  • 6f45d84cfa7bRevision changes
    • warning

      changed the pattern of the request property //////// from ^.{1,80}$ to ^[^\r\n]{1,80}$

    • info

      added the new TRAD enum value to the request property ///////

  • 54f4fe726d8fRevision changes
    • breaking

      added subschema #1 subschema #2 to the //// request property allOf list

    • breaking

      added subschema #1 subschema #3 to the //// request property allOf list

    • warning

      removed subschema #1 subschema #2 from the //// request property allOf list

    • warning

      removed subschema #1 subschema #3 from the //// request property allOf list