v4

OpenAPI 3.1.02026-08-012402353.8 MB

Reverse an Inbound Wire Transfer

post/inbound_wire_transfers/{inbound_wire_transfer_id}/reverse

Path parameters

inbound_wire_transfer_idstring required

The identifier of the Inbound Wire Transfer to reverse.

Request body

reason'duplicate' | 'creditor_request' | 'transaction_forbidden' required

Reason for the reversal.

Example request

{
  "reason": "creditor_request"
}

Response

Inbound Wire Transfer

account_idstring required

The Account to which the transfer belongs.

account_number_idstring required

The identifier of the Account Number to which this transfer was sent.

amountinteger required

The amount in USD cents.

created_atstring date-time required

The ISO 8601 date and time at which the inbound wire transfer was created.

creditor_address_line1string nullable required

A free-form address field set by the sender.

creditor_address_line2string nullable required

A free-form address field set by the sender.

creditor_address_line3string nullable required

A free-form address field set by the sender.

creditor_namestring nullable required

A name set by the sender.

debtor_account_numberstring nullable required

The account number of the sender.

debtor_address_line1string nullable required

A free-form address field set by the sender.

debtor_address_line2string nullable required

A free-form address field set by the sender.

debtor_address_line3string nullable required

A free-form address field set by the sender.

debtor_namestring nullable required

A name set by the sender.

debtor_routing_numberstring nullable required

The American Banking Association (ABA) routing number of the sender.

descriptionstring required

An Increase-constructed description of the transfer.

end_to_end_identificationstring nullable required

A free-form reference string set by the sender, to help identify the transfer.

idstring required

The inbound wire transfer's identifier.

input_message_accountability_datastring nullable required

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_numberstring nullable required

The American Banking Association (ABA) routing number of the bank that sent the wire.

instruction_identificationstring nullable required

The sending bank's identifier for the wire transfer.

purposestring nullable required

The reason for the wire transfer, as set by the sender.

status'pending' | 'accepted' | 'declined' | 'reversed' required

The status of the transfer.

type'inbound_wire_transfer' required

A constant representing the object's type. For this resource it will always be inbound_wire_transfer.

unique_end_to_end_transaction_referencestring nullable required

The Unique End-to-end Transaction Reference (UETR) of the transfer.

unstructured_remittance_informationstring nullable required

A free-form message set by the sender.

wire_drawdown_request_idstring nullable required

The wire drawdown request the inbound wire transfer is fulfilling.

Example response

{
  "acceptance": {
    "accepted_at": "2020-01-31T23:59:59Z",
    "transaction_id": "transaction_uyrp7fld2ium70oa7oi"
  },
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "amount": 100,
  "created_at": "2020-01-31T23:59:59Z",
  "creditor_address_line1": "33 Liberty Street",
  "creditor_address_line2": "New York, NY, 10045",
  "creditor_address_line3": null,
  "creditor_name": "National Phonograph Company",
  "debtor_account_number": "987654321",
  "debtor_address_line1": "33 Liberty Street",
  "debtor_address_line2": "New York, NY, 10045",
  "debtor_address_line3": null,
  "debtor_name": "Ian Crease",
  "debtor_routing_number": "101050001",
  "description": "Inbound wire transfer",
  "end_to_end_identification": "Invoice 29582",
  "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
  "input_message_accountability_data": "20220118MMQFMP0P000001",
  "instructing_agent_routing_number": "101050001",
  "instruction_identification": "202201180000001",
  "purpose": "CASH",
  "reversal": null,
  "status": "accepted",
  "type": "inbound_wire_transfer",
  "unique_end_to_end_transaction_reference": "9a21e10a-7600-4a24-8ff3-2cbc5943c27a",
  "unstructured_remittance_information": "INVOICE 2468",
  "wire_drawdown_request_id": null
}