TransferSwift

Cancel an outgoing international wire

Send a cancellation request to recall funds from the beneficiary for an outgoing international wire transfer. The beneficiary may approve or reject the cancellation request. Cancellation status can be tracked via the Tracking API.

post/transfers/international-wire/{swift_transfer_id}/cancel

Request

Base URL: https://api.column.com
URL: https://api.column.com/transfers/international-wire/{swift_transfer_id}/cancel
Auth: HTTP basic

Path parameters

swift_transfer_idstring required

Request body

cancellation_reasonstring

The reason for canceling the transfer. Possible values: incorrect_amount, incorrect_currency, requested_by_originator, duplicate, fraud, tech_failure, payment_not_justified.

Response

Successful response

account_number_idstring required

ID of the account number that is sending/receiving the transfer

allow_overdraftboolean required

Allows the account to go negative for an outgoing transfer. The bank account needs to have is_overdraftable enabled with an overdraft reserve account linked to it

amountinteger required

Amount (in the smallest unit of the currency) of the funds that will be debited from the originator account for an outgoing transfer (including all fees), or credited to the beneficiary account for an incoming transfer (after deducting any fees). e.g. $1.75 would be represented by 175.

bank_account_idstring required

ID of the bank account that is sending/receiving the transfer

beneficiary_account_numberstring required

The account number of the beneficiary

beneficiary_fistring required

The SWIFT BIC code or US ABA routing number of the beneficiary's financial institution

beneficiary_namestring required

The name of the beneficiary

canceled_atstring date-time nullable

The timestamp when a held international wire was canceled and the funds returned to the available balance

cancellation_reasonstring nullable required

The reason if the transfer is requested to be canceled

cancellation_statusstring nullable required

The status of cancellation request. Possible statuses are pending, accepted, and rejected.

charge_bearerstring required

The charge bearer code. Can be DEBT, CRED, or SHAR.

column_fixed_feeinteger required

The amount (in the smallest unit of currency_code) of fixed fee charged by Column for an outgoing transfer. This is not included in the charges field.

completed_atstring date-time nullable required

The timestamp when the international wire was completed

counterparty_idstring required

ID of the counterparty that is receiving/sending the transfer

created_atstring date-time required

The timestamp when the international wire was created

currency_codestring required

Currency of amount. The three-letter currency code defined in ISO 4217 (e.g. USD).

descriptionstring nullable required

The description of the transfer visible only in your platform

end_to_end_idstring nullable required

Unique ID to unambiguously identify the transaction. This ID is passed on, unchanged, throughout the entire end-to-end chain, and can be used for reconciliation or to link tasks relating to the transaction.

fx_quote_idstring required

The ID of the foreign exchange quote

fx_ratestring required

The foreign exchange rate used for currency exchange of this transfer, including your platform FX rate margin markup

hold_atstring date-time nullable

The timestamp when the international wire entered the hold state

idstring required

The ID of this international wire transfer

idempotency_keystring nullable required

The idempotency key specified in the wire transfer

initiated_atstring date-time nullable required

The timestamp when the international wire was initiated

instructed_amountinteger nullable required

Instructed amount (in the smallest unit of the currency) of the transfer. e.g., 1756 means 1.756 in KWD, 17.56 in USD, or 1756 in JPY.

instructed_currency_codestring required

Instructed currency. The three-letter currency code defined in ISO 4217 (e.g. USD).

instruction_idstring nullable required

Unique ID assigned by the sender of this message

instruction_to_beneficiary_fistring required

Further information for the beneficiary's financial institution

intermediary_fisstring[] required

The SWIFT BIC codes of intermediary financial institutions

is_incomingboolean required

Indicates whether the wire transfer was incoming ( true or outgoing false )

manual_review_atstring date-time nullable required

The timestamp when the international wire went into the manual review state

originator_account_numberstring required

The account number of the originator

originator_fistring required

The SWIFT BIC code or US ABA routing number of the originator's financial institution

originator_namestring required

The name of the originator

pending_submission_atstring date-time nullable required

The timestamp when the international wire was pending for submission

platform_fixed_feeinteger required

The amount (in the smallest unit of the currency_code) of fixed fee charged by your platform for an outgoing transfer. This is not included in the charges field.

platform_fx_feeinteger required

The amount (in the smallest unit of the currency_code) of FX fee charged by your platform for an outgoing FX transfer. This is not included in the charges field.

raw_messagestring nullable required

Raw initial transfer message in the Swift MT103 or ISO 20022/MX pacs.008 format. Only populated if it is queried with expand=raw_message parameter.

return_reasonstring nullable required

The reason if this transfer is returned

returned_amountinteger nullable required

The amount (in the smallest unit of the currency) if this transfer is returned. e.g., 1756 means 1.756 in KWD, 17.56 in USD, or 1756 in JPY.

returned_atstring date-time nullable required

The timestamp when the international wire was returned

returned_currency_codestring nullable required

The currency if this transfer is returned. The three-letter currency code defined in ISO 4217 (e.g. USD).

reviewsobject[]

List of approval reviews associated with the international wire transfer.

settled_amountinteger nullable required

Settlement amount (in the smallest unit of the currency) of the transfer. e.g., 1756 means 1.756 in KWD, 17.56 in USD, or 1756 in JPY.

settled_currency_codestring required

Settlement currency. The three-letter currency code defined in ISO 4217 (e.g. USD).

settlement_datestring required

The date (in ET time zone) when funds are sent to the beneficiary bank for an outgoing transfer, or received from the originator bank for an incoming transfer. Format: YYYY-MM-DD.

The current status of the international wire transfer. Possible statuses are pre_review, initiated, hold, canceled, manual_review, pending_review, pending_submission, submitted, completed, pending_return and returned. pending_review indicates an incoming international wire is on hold pending creditor/debtor data repair.

submitted_atstring date-time nullable required

The timestamp when the international wire was submitted to the SWIFT network

uetrstring nullable required

Universally unique ID to provide an end-to-end reference for this transfer. Format: UUID v4.

ultimate_beneficiary_namestring required

The name of the ultimate beneficiary to which this transfer is due

ultimate_originator_counterparty_idstring required

ID of the ultimate originating counterparty that ordered the payment. Only populated for Direct USD settlement transfers that include an ultimate originator. Empty for traditional SWIFT transfers or transfers without an ultimate originator.

ultimate_originator_namestring required

The name of the ultimate party that owes an amount to the (ultimate) beneficiary

updated_atstring date-time required

The timestamp when the international wire was updated

Example response

{
  "account_number_id": "acno_2F37RhDUnWtB4GD9JXQEDYu7YAY",
  "allow_overdraft": false,
  "amendment_info": null,
  "amount": 17965,
  "bank_account_id": "bacc_2F37RbG3NZAr7Yn2d1i5hITz9O4",
  "beneficiary_account_number": "1234567890",
  "beneficiary_address": {
    "city": "London",
    "country_code": "GB",
    "line_1": "123 Threadneedle Street",
    "line_2": "",
    "postal_code": "EC2R 8AH",
    "state": "LND"
  },
  "beneficiary_fi": "BKENGB20",
  "beneficiary_name": "Bob Trimble",
  "cancellation_reason": null,
  "cancellation_status": null,
  "charge_bearer": "SHAR",
  "charges": [
    {
      "agent": "CLNOUS66",
      "amount": 500,
      "currency_code": "USD"
    },
    {
      "agent": "CHASGBGLT",
      "amount": 500,
      "currency_code": "CNY"
    }
  ],
  "column_fixed_fee": 2500,
  "completed_at": null,
  "counterparty_id": "cpty_2ESSJPnpof38GraQR5C6EnfFGKw",
  "created_at": "2022-09-20T21:55:31Z",
  "currency_code": "USD",
  "description": "SWIFT transfer with CNY",
  "end_to_end_id": "",
  "fx_quote_id": "fxqt_2F3BY6XCpKQUy5cGCqPgLf3Kit7",
  "fx_rate": "6.872100000",
  "id": "swft_2F3BYA9aMdHag8iUtsDE8ji0KOK",
  "idempotency_key": null,
  "initiated_at": "2022-09-20T21:55:31Z",
  "instructed_amount": 123456,
  "instructed_currency_code": "CNY",
  "instruction_id": "XF7MBKI09TUNZXIL",
  "instruction_to_beneficiary_fi": "please contact with the beneficiary before releasing the funds",
  "intermediary_fis": [],
  "is_incoming": false,
  "manual_review_at": null,
  "originator_account_number": "366763686659680",
  "originator_address": {
    "city": "San Francisco",
    "country_code": "US",
    "line_1": "12345 Mission St.",
    "line_2": "",
    "postal_code": "94016",
    "state": "CA"
  },
  "originator_fi": "CLNOUS66",
  "originator_name": "Alice Biden",
  "pending_submission_at": "2022-09-20T21:55:32Z",
  "platform_fixed_fee": 1000,
  "platform_fx_fee": 500,
  "raw_message": null,
  "remittance_info": {
    "general_info": "downpayment for mortgage ID 123546"
  },
  "return_reason": null,
  "returned_amount": null,
  "returned_at": null,
  "returned_currency_code": null,
  "settled_amount": 123456,
  "settled_currency_code": "CNY",
  "settlement_date": "2022-09-20",
  "status": "submitted",
  "submitted_at": "2022-09-20T21:59:16Z",
  "uetr": "d6e4313a-e186-4b21-83a5-43fa4cbaa38e",
  "ultimate_beneficiary_address": null,
  "ultimate_beneficiary_name": "",
  "ultimate_originator_address": null,
  "ultimate_originator_counterparty_id": "",
  "ultimate_originator_name": "",
  "updated_at": "2022-09-20T22:09:18Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.