Sign in

v1

latestOpenAPI 3.0.12026-07-26106359429.8 KB
Simulation

Simulate Incoming Wire Return V2

Simulates an incoming return wire against an outgoing wire in sandbox. Automatically advances to posted on creation.

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

Path parameters

wire_idstring required

ID of the outgoing wire (or outgoing return wire) you want to return.

Request body

amountinteger

The amount of the wire transaction in cents.

reason'account_blocked' | 'wrong_amount' | 'creditor_name_mismatch' | 'honor_return_request' | 'fraud_suspected' | 'creditor_request' | 'narrative' | 'missing_debtor_data' | 'missing_creditor_data' required

The reason for returning the wire.

return_additional_informationstring

Additional details about why the wire is being returned.

Example request

{
  "amount": 5000,
  "reason": "creditor_request"
}

Response

Incoming wire return object created. The response body is empty.

SimulateResponse required