The bank simulator allows customers to simulate payments, payment status reports, and account statements received from partner banks, CSMs, or connectivity providers to create payments, balances, and transactions as well as update payment statuses.

The bank simulator can be used in two different ways:

Use built-in scenarios like creating incoming payments, updating payment statuses, or creating balances and transactions
Upload a bank or CSM messages to trigger the creation of related incoming payments, balances, and transactions or update of related payments

1. Built-in scenarios

The bank simulator supports the the following built-in scenarios:

2. Bank or CSM message upload

You can use the Simulate message received endpoint to upload a bank or CSM message.

The bank simulator uses standard XML messages, Swift MT messages, and Bacs Standard 18 messages. For corporate customers, standard ISO 20022 XML messages are supported. For SEPA indirect or direct participant customers, standard EPC XML messages are supported.

Contact [email protected] if you need technical support to use the bank simulator.

Header

The content type differs based on the type of message. For XML messages, use Content-Type: "application/xml". For other types of messages like Swift MT messages or Bacs Standard 18 messages, use Content-Type: "text/plain".

Query params

Param	Description
id string	The ID of the connected account used to receive the message and create or update the corresponding Numeral object.
bank_service string	The bank service to use, e.g., `sct`, `sdd`, `chaps`, `bacs`, `swift`… Make sure the corresponding bank service is a feature activated for the connected account used. Features activated for a connected account can be found in Settings > Connected accounts > Features activated.
file_name string	The unique file name to generate with up to 35 characters. The file name might or might not include a file extension.

Body params

Param	Description
data string	The raw content of the message to be sent.