Cancel a transfer
To use this endpoint from the browser, you’ll need to specify the
/accounts/{accountID}/transfers.write scope when generating a token.
POST
/accounts/{accountID}/transfers/{transferID}/cancellations
Successfully initiated a cancellation.
{
"cancellationID": "8df8e13c-3c20-4b4b-b265-796534cf4275",
"createdOn": "2023-09-09T14:15:22Z",
"status": "completed"
}Successfully initiated a cancellation but an error occurred while waiting for a synchronous response.
{
"cancellationID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
"createdOn": "2019-08-24T14:15:22Z",
"status": "pending"
}Cancellation request failed, an error message will be available in the response body.
{
"error": "Cannot cancel a transfer with a pending cancellation."
}The request body could not be processed.
Request was refused due to rate limiting.
Response headers
Retry-After
number
Path parameters
accountID
string
<uuid>
required
Identifier for an account.
transferID
string
<uuid>
required
Identifier for the transfer.
Response
application/json
cancellationID
string<uuid>
<=36 characters
required
UUID
createdOn
string<date-time>
<=24 characters
required
status
string<enum>
required
Cancellation status.
Possible values:
pending,
completed,
failed