ISECure REST API · test environment
Bank Simulator
Start testing the complete payment-file path while the real bank agreement and production certificates are still in progress. Bank Simulator uses the existing File Exchange API and TypeScript SDK with bank identifier simulator.
- File Exchange base URL
https://ws-api.test.isecure.fi/v2- Bank
simulator
- Test environmentRegistration required · Paid subscription required · Request access
Exact status and scope
Test environment
Only for bank simulator at https://ws-api.test.isecure.fi/v2. Simulator evidence does not prove real-bank behavior.
Request Bank Simulator accessLimitations
- Synthetic test data only.
- No bank agreement, production channel, or real payment.
- The current account, opening balance, and default scenario are fixed; customers cannot yet configure banks, accounts, authorizations, or scenarios.
API documentation
The Experimental control API configures synthetic banks, accounts, opening balances, scenarios and runs. It is separate from the fixed Beta File Exchange example below and requires its own access and permissions.
Read the operation reference, authentication guide and TypeScript examples. Both APIs use the existing ISECure registration and login, followed by a separate Processing session.
What you can test today
You can enroll a test certificate, download an opening statement, upload a locally signed pain.001.001.09, and retrieve synthetic pain.002, camt.054, and updated camt.053 files before the real bank connection is ready.
When the bank agreement, credentials, and production certificates are ready, point the exact same File Exchange API contract at the separately configured and qualified real-bank connection. Bank Simulator remains available as the test destination; there is no second bank-connection integration to replace it.
Drive tests with the Bank Simulator API
Use the Bank Simulator API to configure test workspaces, synthetic accounts and scenarios, start simulations, and inspect their events and results. Drive it from your own automated tests. Bank-file uploads and downloads use the separate File Exchange API.
Environment and interface
The test base URL is https://ws-api.test.isecure.fi/v2. Bank Simulator is available only in the ISECure test environment.
Use the same registration, login, certificate, and file operations as for other banks. File Exchange uses the same SDK methods as real banks; select Bank: "simulator" in the client configuration.
Enroll the certificate
There is no separate service for retrieving a simulator WS user ID or PIN. Generate both values in your test application and submit them with the existing enrollCert operation. Company must match the registered test account.
- WsUserId: 1–16 bytes of printable ASCII without control characters
- Code: 16–32 bytes of printable ASCII without whitespace or control characters
- Treat both as short-lived test values and keep them out of source code and logs
Download the first statement
A fresh direct enrollment creates one NEW camt.053.001.02 statement. It contains synthetic account FI2112345600000785, equal OPBD and CLBD balances of EUR 10,000,000.00, and no entries.
List it with FileType camt.053.001.02 and Status NEW, then pass the returned opaque FileReference to downloadFile. Repeated download returns identical bytes; its status moves from NEW to DLD and it remains visible under ALL.
Upload a signed payment and download feedback
Generate an OpenPGP key pair locally, register only the public key for authorize use, and sign a synthetic pain.001.001.09 file inside your application before calling uploadFile.
An accepted upload produces these synthetic files for listing and download:
- pain.002.001.10 payment status feedback
- camt.054.001.02 debit notification
- a new camt.053.001.02 with the updated statement data
Tenant-specific state
The simulator connection, file references, and artifacts belong only to the ISECure tenant that created them. Another customer cannot list, download, or change them.
Limits of the fixed File Exchange example
The current Beta product uses one fixed synthetic account, opening balance, and deterministic default scenario.
- No custom banks, accounts or opening balances in this fixed example
- No WebServices user, file-type, direction, or profile authorization configuration
- Custom scenarios, faults, cutoffs, time and branches use the separate control API
Capabilities and direction
| Direction | Capability |
|---|---|
| Output | Initial statementFresh enrollment creates a listable and downloadable camt.053.001.02 file. |
| Input | Signed paymentAccepts a locally signed synthetic pain.001.001.09 file. |
| Output | Feedback filesProduces pain.002.001.10, camt.054.001.02, and an updated camt.053.001.02. |
Frequently asked questions
Does the simulator need a separate SDK?
No. Use the same REST operations and TypeScript SDK with the bank setting simulator.
Can I use Processing API before the simulator?
Yes. Processing API can prepare the checked pain.001 file in a separate session. Your application verifies and signs it locally before uploading to bank simulator. The current examples are separate and feedback is not correlated automatically.
Can customers see each other's files?
No. Simulator connections, file references, and files are tenant-specific.