Wire Return
(Outbound) Wire Return
You may return an unwanted inbound wire by utilizing the return wire payment endpoint.
To return a wire you must provide the Payments Orchestrator transaction ID of the inbound wire you wish to return as well as the following information from the original wire:
- An existing Payments Orchestrator counterparty reference which contains the following information:
- Beneficiary Account Number
- Beneficiary Name
- Beneficiary Address
- Receiving Bank ABA Routing Number
This required information on the receiving wire can be provided either as an existing counterparty or as individual fields on the wire return request.
Note that a Wire Return may only be created once per Inbound Wire. You may not return the same Wire more than once.
(Outbound) Wire Returns created in Payments Orchestrator are transmitted to the bank for processing shortly after they are created. The status of a Wire Return can be tracked through the following states:
Pending- Wire Returns enter aPendingstate when the object is initially created.Processing- Wire Returns are briefly in aProcessingstate while they are transmitted to the sponsor bank for origination.Sent- Wire Returns enter into aSentstate after being transmitted to the financial institution for processing.Success- Wire Returns are marked as being in a ‘Success’ state after being processed by the originating bank.Failed- Wire Returns are marked asFailedwhen an issue occurs while being processed.
Note
The Receiving Bank ABA Routing Number, whether contained within a counterparty or passed in individually, must match the ABA Routing Number from the original wire. If these do not match, the wire return will result in a transaction failure.
The Beneficiary Account Number information is typically provided on an inbound wire and included in the inbound wire webhook payload (see documentation). However, it is not always present if the sending Financial Institution decides to strip it out before sending the wire. If the details are missing, either the sending bank has not provided it or the core banking provider has not provided it with the transaction. In this scenario, the wire can attempt to be sent, but there is no guarantee that the receiving Financial Institution will honor the return request. If the receiving Financial Institution rejects the wire return, then you must reach out to the customer to collect this information and attempt the wire return again with the full set of data.
Inbound Wire Return
A returned wire deposit has been received (you have originated an Outbound Wire, and the RDFI has sent it back). These are wires, and as such will have their own unique IMAD and Orchestrator transaction entry and assigned ID.
The following fields are provided in this transaction type to make matching to the original Outbound Wire easier.
| Field Name | Description |
|---|---|
| parent_reference_id | The Orchestrator transaction ID relating to the Outbound Wire that resulted in this Inbound Wire Return |
| parent_client_reference_id | The client_reference_id passed in with the Outbound Wire that resulted in this Inbound Wire Return |
| parent_transaction_imad | The FED issued IMAD relating to the Outbound Wire that resulted in this Inbound Wire Return |
Inbound Wire Return transactions received by Payments Orchestrator will transition through the following statuses:
Pending- An Inbound Wire Return enters aPendingstate when the object is initially created.On Hold- Inbound Wire Returns may enter a status ofOn Holdwhile they’re reviewed by the receiving bank. Funds are not available.Success- Inbound Wire Returns are marked as being in a ‘Success’ state after being processed by the receiving bank.Failed- Inbound Wire Returns are marked asFailedwhen an issue occurs while being processed. No funds have been received.