Simulating Scheme Actions via API
How to simulate inbound payments, payment execution, and payment failures via the Lorum sandbox API.
The Lorum sandbox API allows you to simulate payment scheme actions programmatically. Use these endpoints to test your integration end-to-end without waiting for real scheme processing.
Simulate endpoints are only available in sandbox.
Simulate Inbound Payment
Simulate an inbound payment settling into an account via Simulate Inbound Payment
POST /v1/simulate/inbound-payment
| Field | Type | Required | Description |
|---|---|---|---|
account_id | uuid | ✅ | The account to receive the simulated inbound payment |
amount | integer | ✅ | Amount in minor currency (e.g. 100 = 1.00) |
currency | string | ✅ | ISO currency code |
remitter_name | string | ✅ | Name of the simulated remitter |
remitter_iban | string | ✅ | IBAN of the simulated remitter |
external_reference | string | ❌ | Optional reference for the simulated payment |
Simulate Execute Outbound Payment
Simulate a submitted outbound payment being executed by the scheme via Simulate Execute Outbound Payment
POST /v1/simulate/execute-payment
| Field | Type | Required | Description |
|---|---|---|---|
transaction_id | uuid | ✅ | The ID of the outbound payment to execute |
The payment status will update to Executed and an outbound_local_payment_executed webhook event will be fired if the Payments category is enabled.
Simulate Fail Outbound Payment
Simulate a submitted outbound payment failing via Simulate Fail Outbound Payment
POST /v1/simulate/fail-payment.
| Field | Type | Required | Description |
|---|---|---|---|
transaction_id | uuid | ✅ | The ID of the outbound payment to fail |
failure_reason | string | ✅ | A description of the simulated failure reason |
The payment status will update to Failed and an outbound_local_payment_failed webhook event will be fired if the Payments category is enabled.
Simulate Return Payment
Simulate an executed outbound payment being returned by the beneficiary's bank via Simulate Return Payment
POST /v1/simulate/return-payment.
| Field | Type | Required | Description |
|---|---|---|---|
outbound_transaction_id | uuid | ✅ | The ID of the outbound payment to return — must be in an Executed state |
An outbound_local_payment_returned webhook event will be fired if the Payments category is enabled.
Updated 4 days ago