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

Simulate Execute Outbound Payment

Simulate a submitted outbound payment being executed by the scheme via Simulate Execute Outbound Payment

POST /v1/simulate/execute-payment

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.

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.

An outbound_local_payment_returned webhook event will be fired if the Payments category is enabled.