Docs

REST API

Simulation and reset

GET/api/simulation

The simulated rail: scenarios, delay, every simulated account with its balance. enabled: false when no simulation runs.

Response 200

JSON
{
  "ok": true,
  "data": {
    "enabled": true,
    "rail": "sepa-simulation",
    "environment": "SANDBOX",
    "currency": "EUR",
    "delayMs": 0,
    "openingBalance": "1000.00",
    "triggers": {
      "frozenSourceIban": "NL56SIML0000000001",
      "kycRejectedIban": "NL29SIML0000000002"
    },
    "scenarios": [
      {
        "trigger": "any amount not listed below",
        "outcome": "settled immediately",
        "payoutStatus": "paid"
      },
      {
        "trigger": "amount ending in .01",
        "outcome": "rejected: insufficient funds (AM04)",
        "payoutStatus": "failed"
      },
      {
        "trigger": "amount ending in .02",
        "outcome": "rejected: payee account closed (AC04)",
        "payoutStatus": "failed"
      },
      {
        "trigger": "amount ending in .03",
        "outcome": "no confirmation within the timeout; the payment had gone through and settles after the delay",
        "payoutStatus": "processing",
        "then": "paid"
      },
      {
        "trigger": "amount ending in .04",
        "outcome": "no confirmation within the timeout; the payment had been rejected, reported after the delay",
        "payoutStatus": "processing",
        "then": "failed"
      },
      {
        "trigger": "amount ending in .05",
        "outcome": "accepted; settles after the delay",
        "payoutStatus": "processing",
        "then": "paid"
      },
      {
        "trigger": "amount ending in .06",
        "outcome": "settled; returned by the counterparty bank after the delay (AC01), funds credited back",
        "payoutStatus": "paid",
        "then": "returned"
      },
      {
        "trigger": "amount ending in .07",
        "outcome": "rail unavailable; nothing was sent",
        "payoutStatus": "failed"
      },
      {
        "trigger": "debtor IBAN NL56SIML0000000001",
        "outcome": "source account frozen; refused before anything is sent",
        "payoutStatus": "approved"
      },
      {
        "trigger": "source balance below the amount",
        "outcome": "rejected: insufficient funds (AM04)",
        "payoutStatus": "failed"
      },
      {
        "trigger": "payee IBAN NL29SIML0000000002",
        "outcome": "KYC rejected after the delay",
        "payoutStatus": "kyc_rejected"
      },
      {
        "trigger": "any other payee",
        "outcome": "KYC approved after the delay",
        "payoutStatus": "approved"
      }
    ],
    "accounts": [
      {
        "iban": "NL91ABNA0417164300",
        "balance": "929.97",
        "currency": "EUR",
        "status": "ACTIVE"
      }
    ]
  }
}

POST/api/reset

Empty the store and the simulated ledger. Sandbox only.

Response 200

JSON
{
  "ok": true,
  "data": {
    "payouts": []
  }
}