Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Bank Simulator

Update payment status

Update the status of a payment to test your integration. Used to switch payment orders, returns, and instant incoming payments to their final status. This endpoint can only be used in the sandbox environment.

post/simulator/{connected_account_id}/payment_status_reports

Path parameters

connected_account_idstring uuid required

The connected account ID.

Request body

payment_idstring uuid required

The payment ID which new status needs to be simulated. Only sent and pending payment orders, sent returns, and confirmed incoming payments can be chosen.

status'executed' | 'rejected' | 'pending' | 'received' required

The new payment status to be transitioned to. Allowed values include executed (for payment orders and returns), rejected (for payment orders, returns, and incoming payments), pending (for payment orders), and received (for confirmed SEPA instant incoming payments).

reason_codestring

ISO reason code to be used when rejecting a payment.

Example request

[
  {
    "payment_id": "acc2ef51-5c71-4a1e-b011-ecdbce1b9b73",
    "status": "executed",
    "reason_code": "AC04"
  }
]

Response

Payment status was successfully updated.

Example response

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