Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Bank Simulator

Simulate message received

Simulate a message received from a partner bank or CSM. Learn how to use the bank simulator.

post/simulator/connected_accounts/{connected_account_id}/services/{bank_service}/bank_files/{file_name}

Path parameters

connected_account_idstring uuid required

The ID of the connected account that should receive the message.

bank_service'bacs_direct_credit' | 'bacs_direct_debit' | 'chaps' | 'end_of_day_statements' | 'fps' | 'intra_day_statements' | 'sct' | 'sct_inst' | 'sdd' | 'swift' required

The bank service associated to the message content that should be used when parsing it. The bank_service param depends on your sandbox configuration. If needed, Numeral support team (support@numeral.io) can provide further support.

file_namestring required

The name the file should display once received and processed.

Response

Message was successfully processed.

connected_accountstring required

The same value that was provided in input.

file_namestring required

The same value that was provided in input.

bank_servicestring required

The same value that was provided in input.

file_directionstring required

Always incoming for this flow.

created_atstring date-time required

The UTC timestamp representing the moment we ingested the file.

sizeinteger required

The size of the uploaded file.

Example response

{
  "connected_account": "74ed567c-ffa9-4b39-a596-f0443721db5a",
  "file_name": "sct",
  "bank_service": "sct",
  "file_direction": "incoming",
  "created_at": "2025-01-26T13:51:10Z",
  "size": 123456
}