Skip to main content
POST
Simulate Incoming Wire Return Request Rejection

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 wire whose outgoing return request you want to simulate a rejection of.

Pattern: ^wire_\w+$

Body

application/json
reason
enum<string>
required

Reason the return request was rejected.

  • account_closed — ISO AC04.
  • non_sufficient_funds — ISO AM04.
  • customer_requested — ISO CUST. Customer declined the return.
  • legal_decision — ISO LEGL.
  • customer_no_response — ISO NOAS. Customer did not respond by the deadline.
  • returned_previously — ISO ARDT. Wire already fully returned. Auto-set by Lead when applicable.
  • narrative — ISO NARR. Catch-all; details field carries the explanation.
  • per_agent_request — ISO AGNT. Incoming only.
  • other — Incoming only. Catch-all for unmapped ISO codes received from the counterparty.
Available options:
account_closed,
non_sufficient_funds,
customer_requested,
legal_decision,
customer_no_response,
returned_previously,
narrative,
per_agent_request,
other
additional_information
string

Free-text explanation included with the simulated rejection.

Maximum string length: 105

Response

The updated wire object, with the outgoing return request now in rejected status.

The response is of type object.