Skip to main content
POST
Simulate Incoming Wire Return Request

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

wire_id
string
required

ID of the outgoing wire you want to simulate an incoming return request against.

Pattern: ^wire_\w+$

Body

application/json
reason
enum<string>
required

Reason for the return request.

  • creditor_account_number_invalid — ISO AC03. Wire was sent to the wrong account number.
  • wrong_amount — ISO AM09. Wire amount is not the agreed amount or expected.
  • customer_requested — ISO CUST. The partner's end customer requested the return.
  • duplication — ISO DUPL. Duplicate wire sent.
  • fraud_suspected — ISO FRAD. Fraud suspected.
  • narrative — ISO NARR. Catch-all when no structured reason fits; details field carries the explanation.
  • technical_problem — ISO TECH. A technical issue caused the wire to be sent.
  • undue_payment — ISO UPAY. Payment was not due or for services not performed.
  • per_agent_request — ISO AGNT. Incoming only — Lead is the agent for outgoing payments.
  • other — Incoming only. Catch-all for unmapped ISO codes received from the counterparty.
Available options:
creditor_account_number_invalid,
wrong_amount,
customer_requested,
duplication,
fraud_suspected,
narrative,
technical_problem,
undue_payment,
per_agent_request,
other
additional_information
string

Free-text explanation included with the simulated request.

Maximum string length: 105

Response

The updated wire object, now containing the new return request entry.

The response is of type object.