Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Wire Transaction Simulations

Simulate receiving Wire transaction

Use to simulate receiving Wire transaction in test environments. Creates an incoming Wire file, which gets automatically processed.

post/wires/transaction_simulations/receiving_transaction

Request body

account_numberstring required

Number of the receiving account

amountinteger required

Amount to transfer in cents (e.g. 100 = $1).

beneficiary_account_overridestring

Simulation-only knob. If present, replaces account_number as the value placed in the generated pacs.008 CdtrAcct field (use the empty string to omit CdtrAcct entirely). account_number still drives partner-prefix validation and the receiver-info lookup; this override only affects what is stamped on the wire, which is what the receiver code parses into IncomingWire.AccountNo. Used to construct the "structured account is missing/short, account digits embedded in recipient message" scenario. Not used in production wires. FEDWIRE only.

network'DATASOFT' | 'FEDWIRE'

Network to use for the Wire transfer

recipient_messagestring

Simulation-only knob. Overrides the unstructured remittance information (ISO 20022 RmtInf/Ustrd) on the generated wire so we can exercise the recipient-message account-number extraction path. Not used in production wires. FEDWIRE only — rejected for DATASOFT since the Datasoft webhook payload has no field to carry an unstructured recipient message.

Example request

{
  "account_number": "123638791329",
  "amount": 607,
  "network": "FEDWIRE",
  "recipient_message": "ACCT 1234567890"
}

Response

Simulated receiving a Wire transaction

OR

Example response

{
  "file_name": "SIMULATION.20230709T222327.086_221.txt"
}