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

Simulate receiving Wire transaction

cURL

curl --request POST \
  --url https://api.synctera.com/v2/wires/transaction_simulations/receiving_transaction \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_number": "123638791329",
  "amount": 607,
  "beneficiary_account_override": "",
  "network": "FEDWIRE",
  "recipient_message": "ACCT 1234567890"
}
'

201

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

Authorizations

Authorization · string · header · required

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

Body

application/json

Incoming Wire simulation request

Simulate receiving a Wire transaction

account_number · string · required

Number of the receiving account

Example:

"123638791329"

amount · integer · required

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

Required range: x >= 1

Example:

607

beneficiary_account_override · string

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.

Example:

""

network · enum<string> · default: FEDWIRE

Network to use for the Wire transfer

Available options: FEDWIRE, DATASOFT

Example:

"FEDWIRE"

recipient_message · string

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:

"ACCT 1234567890"

Response

201

application/json

Simulated receiving a Wire transaction

Option 1

Option 2

Incoming Wire simulation result with the created file name

file_name · string · required

Example:

"SIMULATION.20230709T222327.086_221.txt"