Simulating scheme actions in sandbox

Simulate bank actions to fully test various actions that would normally be completed by the payment scheme.

The sandbox environment provides the following scheme actions:

  • simulate an inbound payment,
  • simulate an outbound payment being executed,
  • simulate an outbound payment failing.

These functions are available over API and in the portal.

🚧

Simulate functions are only available in sandbox

Simulate inbound payment

Portal

Simulate inbound payment can be found in the create paymentactions menu.

Select the account that will be the beneficiary of the inbound payment.

The account balance will reflect the simulated inbound transaction and the transaction will appear on the account.

API

Call the simulate inbound payment API to simulate a inbound payment. Here is a guide for calling this API:

Simulate execute outbound payment

Portal

The simulate execute payment is available from the actions button when viewing the transaction.

API

Call simulate executed status for an outbound payment API passing in the transaction_id to execute the payment.

Simulate fail outbound payment

Portal

The simulate fail payment is available from the actions button when viewing the transaction.

API

Call simulate failed status for an outbound payment API passing in a failed_reason (string) and the transaction_id.