The bank simulator allows customers to simulate messages received from partner banks or CSMs to create payments, balances, and transactions as well as update payment statuses.

Messages received using the bank simulator are processed like regular messages received from partner banks or CSMs and create or update the corresponding Numeral objects.

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.

Common use cases

Common use cases include:

Receiving a pacs.002 payment status report with ACSP status code to update the status of a payment order from sent to executed
Receiving a pacs.002 payment status report with RJCT status code status code to update the status of a payment order from sent to rejected
Receiving a pacs.008 payment message to create SEPA credit transfer incoming payments
Receiving a camt.053 account statement message to create balances and transactions

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.