increase-test
POST/inbound_wire_transfers/{inbound_wire_transfer_id}/reverse

Reverse an inbound wire transfer

Reverses an inbound wire transfer. Supply a reason to record why the transfer is being reversed; the response contains the updated transfer.

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

1 parameter · 1 body field
inbound_wire_transfer_idstringrequired
The identifier of the inbound wire transfer to reverse.

Reversal details for the inbound wire transfer.

reasonstringrequired
Reason for the reversal.
Allowed:duplicatecreditor_requesttransaction_forbidden

3 status codes
200Returns the inbound wire transfer after the reversal action.
acceptanceobjectrequired
If the transfer is accepted, this will contain details of the acceptance.
account_idstringrequired
The Account to which the transfer belongs.
account_number_idstringrequired
The identifier of the Account Number to which this transfer was sent.
amountintegerrequired
The amount in USD cents.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound wire transfer was created.
creditor_address_line1stringrequired
A free-form address field set by the sender.
creditor_address_line2stringrequired
A free-form address field set by the sender.
creditor_address_line3stringrequired
A free-form address field set by the sender.
creditor_namestringrequired
A name set by the sender.
debtor_account_numberstringrequired
The account number of the sender.
debtor_address_line1stringrequired
A free-form address field set by the sender.
debtor_address_line2stringrequired
A free-form address field set by the sender.
debtor_address_line3stringrequired
A free-form address field set by the sender.
debtor_namestringrequired
A name set by the sender.
debtor_routing_numberstringrequired
The American Bankers' Association (ABA) routing number of the sender.
descriptionstringrequired
An Increase-constructed description of the transfer.
end_to_end_identificationstringrequired
A free-form reference string set by the sender, to help identify the transfer.
idstringrequired
The inbound wire transfer's identifier.
input_message_accountability_datastringrequired
A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.
instructing_agent_routing_numberstringrequired
The American Bankers' Association (ABA) routing number of the bank that sent the wire.
instruction_identificationstringrequired
The sending bank's identifier for the wire transfer.
purposestringrequired
The reason for the wire transfer, as set by the sender.
reversalobjectrequired
If the transfer is reversed, this will contain details of the reversal.
statusstringrequired
The status of the transfer.
Allowed:pendingaccepteddeclinedreversed
typestringrequired
A constant representing the object's type. For this resource it will always be `inbound_wire_transfer`.
Allowed:inbound_wire_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)) of the transfer.
unstructured_remittance_informationstringrequired
A free-form message set by the sender.
wire_drawdown_request_idstringrequired
The wire drawdown request the inbound wire transfer is fulfilling.
4XXReturned when the request cannot be completed because of a client-side error.
5XXReturned when the request cannot be completed because of a server-side error.

Error handling

The inbound_wire_transfer_id path parameter must identify the inbound wire transfer to reverse. The request body must include reason, set to duplicate, creditor_request, or transaction_forbidden.