Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Wire Return

Simulate an incoming Wire Return.

post/v1/simulate/wires/{wire_id}/incoming_return

Path parameters

wire_idstring required

ID of the Wire object you want to return.

Request body

amountinteger

The amount of the wire transaction in cents.

return_code'AC06' | 'AM09' | 'BE01' | 'FOCR' | 'FR01' | 'MS02' | 'NARR' | 'RR02' | 'RR03' required

List of eligible return reason codes for wire transfers.

  • AC06 - account_blocked
  • AM09 - wrong_amount
  • BE01 - creditor_name_mismatch
  • FOCR - honor_return_request
  • FR01 - fraud_suspected
  • MS02 - creditor_request
  • NARR - narrative
  • RR02 - missing_debtor_data
  • RR03 - missing_creditor_data
return_additional_informationstring

Additional details about why the wire is being returned that will be included with the returned wire.

Example request

{
  "amount": 5000,
  "return_code": "AC06"
}

Response

Wire return object created.

SimulateResponse required