v1
latestOpenAPI 3.0.12026-07-26106359429.8 KBSimulation
Simulate Incoming Wire
Simulate an incoming Wire.
post/v1/simulate/wires/incoming
Headers
Idempotency-Keystring required
Idempotency key
Request body
Example request
{
"amount": 5000,
"creditor_account_number_id": "account_number_xyz123",
"debtor": {
"name": "Allan Scott",
"account_identifier": {
"type": "account_number",
"value": "1032345678"
},
"address": {
"department": "Procurement Department",
"sub_department": "IT Procurement",
"street_name": "Main Street",
"building_number": "100",
"building_name": "City Hall",
"floor": "4th Floor",
"post_box": "PO Box 12345",
"room": "600",
"post_code": "12345",
"town_name": "Kansas City",
"town_location_name": "Westside North",
"district_name": "Manhattan",
"country_sub_division": "NY",
"country": "US",
"line_one": "123 Main St",
"line_two": "Suite 100",
"line_three": "Kansas City, MO 64105"
}
},
"remittance_details": {
"message_to_creditor": "Payment for invoice 12345"
},
"payment_identifiers": {
"end_to_end_identification": "EndtoEnd12345"
},
"debtor_agent": {
"routing_number": "021000021"
}
}Response
Incoming Wire object created.
SimulateResponse required