International Wire
International wire tracking object
Object Parameters
cancellation_reason
stringThe reason if the transfer is requested to be canceled. Read more.
cancellation_status
stringThe latest status of cancellation request (Read more). Can be one of the following:
pending: thebeneficiarybankisstillprocessingthecancellationrequest.accepted: the beneficiary bank has accepted the cancellation request. Funds have been returned, or will be returned shortly.rejected: the beneficiary bank has rejected the cancellation request. Funds won't be returned.
completed_amount
numberThe amount (in the smallest unit of the currency) credited to the beneficiary account by the beneficiary bank. e.g., 1756 means 1.756 in KWD, 17.56 in USD, or 1756 in JPY.
completed_at
date-timeThe timestamp when the international wire was completed by the beneficiary bank
completed_currency_code
stringCurrency code of the completed amount. The three-letter currency code defined in ISO 4217 (e.g. USD).
events
array of objectsList of tracking updates of the transfer in ascending order of event timestamp
cancellation_reason
stringThe reason if the transfer is requested to be canceled. Read more.
cancellation_status
stringThe current status of cancellation request by this event (Read more). Can be one of the following:
pending: thebeneficiarybankisstillprocessingthecancellationrequest.accepted: the beneficiary bank has accepted the cancellation request. Funds have been returned, or will be returned shortly.rejected: the beneficiary bank has rejected the cancellation request. Funds won't be returned.
cancellation_status_reason
stringThe reason if the cancellation request is still pending or rejected
charge_bearer
stringThe charge bearer code. Possible values: DEBT, CRED, or SHAR
charges
array of objectsList of fees charged by financial institutions involved in this transfer. Charges are only listed if the intermediary and beneficiary banks are part of the SWIFT GPI tracking system.
agent
stringThe agent or institution that applied the charge.
amount
numberAmount of the charge in the smallest unit of the currency.
currency_code
stringThe three-letter currency code of the charge.
fx_rate
stringThe foreign exchange rate used for currency exchange by this financial institution
instructed_amount
numberInstructed 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_code
stringInstructed currency. The three-letter currency code defined in ISO 4217 (e.g. USD). Read more.
instructed_fi
stringThe SWIFT BIC code of the instructed financial institution (i.e., the next FI in the routing)
is_cover_transfer_event
booleanIndicate if this event is for the cover transfer that settles funds. Cover transfer events will not impact the corresponding customer transfer status.
network_reference
stringThe event ID in the SWIFT tracking system. Unique per transfer.
settled_amount
numberSettlement 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_code
stringSettlement currency. The three-letter currency code defined in ISO 4217 (e.g. USD).
transfer_status
stringThe current transfer status in the SWIFT tracking system by this event. Possible values: pending, rejected, or completed
transfer_status_reason
stringThe reason if the transfer is still pending or rejected
type
stringThe tracking event type. Possible values: fi_transfer_initiated, fi_transfer_updated, fi_transfer_cancellation_requested, fi_transfer_cancellation_responded, fi_transfer_cancellation_tracking_updated, fi_transfer_return_initiated, fi_transfer_return_updated, fi_transfer_cover_initiated, fi_transfer_cover_updated, fi_transfer_cover_return_initiated, fi_transfer_cover_return_updated, transfer_initiated, transfer_updated, transfer_cancellation_requested, transfer_cancellation_responded, transfer_cancellation_tracking_updated, transfer_return_initiated, transfer_return_updated, transfer_cover_initiated, transfer_cover_updated, transfer_cover_return_initiated, transfer_cover_return_updated
updated_at
date-timeThe timestamp when the event was last updated by the SWIFT tracking system
updated_by
stringThe SWIFT BIC code of the financial institution posting this status update, or the SWIFT tracking system (TRCKCHZZXXX)
id
stringThe ID of this international wire transfer
transfer_status
stringThe latest transfer status in the SWIFT tracking system. Possible values: pending, rejected, or completed
transfer_status_reason
stringThe reason if the transfer is still pending or rejected
uetr
stringUniversally unique ID to provide an end-to-end reference for this transfer. Format: UUID v4.
updated_at
date-timeThe timestamp when the transfer was last updated by the SWIFT tracking system