v3

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

Simulate receiving Wire transfer return

Use to simulate receiving a Wire transfer return in test environments. Creates an incoming Wire file with a single return entry based on a previously created outgoing transaction. The file gets automatically processed.

post/wires/transaction_simulations/receiving_return

Request body

wire_idstring uuid required

ID of an outgoing Wire transfer to be returned.

Example request

{
  "wire_id": "23a37f14-16eb-461d-9331-b78182adbad4"
}

Response

Simulated receiving a Wire transfer return

OR

Example response

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