v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Bank Simulator

Create balance

Create a balance to test your integration. This endpoint can only be used in the sandbox environment.

post/simulator/{connected_account_id}/balances

Path parameters

connected_account_idstring uuid required

The connected account ID.

Request body

amountnumber required

Balance amount, in minimum currency unit.

typestring

Balance type. Available balance types can be found here.

currencystring

Balance currency. Only ISO 4217 currency codes are allowed.

direction'debit' | 'credit'

Balance direction. Only debit and credit are allowed.

datestring date

Balance date. The format should be YYYY-MM-DD.

Example request

[
  {
    "amount": 1000,
    "type": "closing_available",
    "currency": "EUR",
    "direction": "credit",
    "date": "2025-12-30"
  }
]

Response

Balance was successfully created.

Example response

{
  "files": [
    {
      "file_id": "acc2ef51-5c71-4a1e-b011-ecdbce1b9b73",
      "file_name": "SIM.V2.SOMETHING.AAABBBCCC",
      "created_at": "2025-01-26T13:51:10Z"
    }
  ]
}