v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB

Bank Simulator

Create transaction

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

post/simulator/{connected_account_id}/transactions

Path parameters

connected_account_idstring uuid required

The connected account ID.

Request body

amountinteger required

The absolute value of the transaction, in the specified currency's smallest unit.

currencystring

The three-letter ISO 4217 currency code, in lowercase.

direction'debit' | 'credit' required

The direction of the transaction, either debit or credit.

type'credit_transfer' | 'direct_debit' | 'instant_credit_transfer' required

The type of the transaction.

account_servicer_referencestring required

The account servicer reference.

referencestring

The reference.

booking_datestring date

The date when a transaction is registered on the account.

value_datestring date

The date when a transaction is effectively credited or debited on the account.

external_account_idstring

The ID of the external account linked to the transaction.

internal_account_idstring

The ID of the internal account linked to the transaction.

Example request

[
  {
    "amount": 2000,
    "currency": "EUR",
    "direction": "credit",
    "type": "credit_transfer",
    "account_servicer_reference": "refbct1234",
    "reference": "Ref. payroll may 2023",
    "booking_date": "2022-01-03",
    "value_date": "2022-01-03",
    "bank_data": {
      "end_to_end_id": "E2EID-01230125941295235",
      "transaction_id": "7f4abc4e33e74e3d8cdf20f5d427010b",
      "instruction_id": "INSTID-01230125941295235",
      "payment_information_id": "PMTINF-01230125941295235"
    },
    "external_account_id": "d08922ee-dce1-45dc-b9cd-c83251fb9fc5",
    "external_account": {
      "account_number": "FR5412739000504811631858C47",
      "holder_name": "Jane Doe"
    },
    "internal_account_id": "d08922ee-dce1-45dc-b9cd-c83251fb9fc5",
    "internal_account": {
      "account_number": "FR4714508000301359366727T71"
    }
  }
]

Response

Transaction 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"
    }
  ]
}