Sign in

v5

latestOpenAPI 3.1.02026-07-262421791.5 MB
transfer

Cancel a transfer

Transfers may be cancelled up until the transfer has been processed and funds converted. Cancellation is final — it cannot be undone.

{% admonition type="info" name="When can a transfer be cancelled?" %} A transfer can only be cancelled programmatically via the API if it meets all of the following criteria:

  • The transfer is not in funds_converted or later state.
  • There are no processing problems with the transfer.

If the transfer does not meet these criteria, the API will return a 409 Conflict error with the code transfer.cancellation.not.allowed.

For more information about transfer states, see Tracking Transfers. {% /admonition %}

put/v1/transfers/{transferId}/cancel

Path parameters

transferIdinteger required

The transfer ID

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Returns the cancelled transfer object, with or without an originator block depending on the type of transfer.

OR

Example response

{
  "id": 16521632,
  "user": 4342275,
  "targetAccount": 8692237,
  "quoteUuid": "8fa9be20-ba43-4b15-abbb-9424e1481050",
  "status": "incoming_payment_waiting",
  "reference": "reference text",
  "rate": 0.89,
  "created": "2017-11-24 10:47:49",
  "details": {
    "reference": "Testing"
  },
  "sourceCurrency": "EUR",
  "targetCurrency": "GBP",
  "targetValue": 150,
  "customerTransactionId": "54a6bc09-cef9-49a8-9041-f1f0c654cd88",
  "payinSessionId": "23330542-8e9e-419f-95eb-312b880f92ad"
}