Sign in

v1

latestOpenAPI 3.1.02026-07-2656258207.2 KB
Transfers

Update a transfer

This can only be used to update instructions about a deferred payout.

put/transfers/{id}

Path parameters

idstring required

ID of the transfer

Headers

X-Trace-Idstring

A unique identifier to track this operation. It must be between 12 and 255 characters in length.

Request body

initiateboolean

Used to initiate a deferred or scheduled transfer

closeboolean

Used to close a deferred or scheduled transfer.

Response

OK

status'success' | 'failed'
messagestring

Example response

{
  "data": {
    "id": "trf_yuK89vb",
    "action": "instant",
    "status": "CANCELLED"
  }
}