increase-test
POST/swift_transfers/{swift_transfer_id}/cancel

Cancel a pending Swift Transfer

Cancels a pending Swift Transfer. Use this operation to cancel a transfer before it proceeds; the transfer must still be pending. The response contains the updated transfer record.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter
swift_transfer_idstringrequired
The identifier of the pending Swift Transfer to cancel.

3 status codes
200Returns the updated Swift Transfer, including its identifier, amount, creditor and debtor details, and transfer metadata.
account_idstringrequired
The Account to which the transfer belongs.
account_numberstringrequired
The creditor's account number.
amountintegerrequired
The transfer amount in USD cents.
bank_identification_codestringrequired
The bank identification code (BIC) of the creditor.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
created_byobjectrequired
What object created the transfer, either via the API or the dashboard.
creditor_addressobjectrequired
The creditor's address.
creditor_namestringrequired
The creditor's name.
debtor_addressobjectrequired
The debtor's address.
debtor_namestringrequired
The debtor's name.
idstringrequired
The Swift transfer's identifier.
idempotency_keystringrequired
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
instructed_amountintegerrequired
The amount that was instructed to be transferred in minor units of the `instructed_currency`.
instructed_currencystringrequired
The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code of the instructed amount.
Allowed:USD
intermediary_bank_identification_codestringrequired
The bank identification code (BIC) of the intermediary bank, if the transfer is routed through one.
pending_transaction_idstringrequired
The ID for the pending transaction representing the transfer.
routing_numberstringrequired
The creditor's bank account routing or transit number. Required in certain countries.
source_account_number_idstringrequired
The Account Number included in the transfer as the debtor's account number.
statusstringrequired
The lifecycle status of the transfer.
Allowed:pending_approvalcanceledpending_initiatingpending_reviewingrequires_attentioninitiatedrejectedreturned
transaction_idstringrequired
The ID for the transaction funding the transfer. This will be populated after the transfer is initiated.
typestringrequired
A constant representing the object's type. For this resource it will always be `swift_transfer`.
Allowed:swift_transfer
unique_end_to_end_transaction_referencestringrequired
The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) for the transfer.
unstructured_remittance_informationstringrequired
The unstructured remittance information that was included with the transfer.
4XXReturned when the request fails with a client error.
5XXReturned when the request fails with a server error.

Error handling

The swift_transfer_id path parameter must identify the pending Swift Transfer to cancel. The transfer must still be pending for cancellation.