JavaScript is disabled. Some features may not work. You can also read the static version: View text version

Simulating scenarios

You can simulate changes in state for sources, mandates and ACH debits. This enables you to test out various scenarios.

The Test (sandbox) environment has a simulation feature that enables you to test out various scenarios from the dashboard and API. The simulations are described below.

Note: The simulations are designed to mimic the production environment closely to assist you with engineering scenarios, but the simulations do not replicate all external errors and validations. For example, simulating successful submission of an emandate_api source in the sandbox does not indicate that the exact same source parameters will lead to successful source submission in production - because a destination bank may reject a source submission attempt for any one of dozens of reasons and they each have their own internal validation policies and rules (which are not published). See the relevant article for rejection/error response for further information.

Source (emandate_api) simulation

Create a new source. It starts in pending status.
Go to the pending source's authorisation link and simulate the source to 'accepted'. Its status transitions to submitted. An active mandate is created.
Go to the pending source's authorisation link and simulate the source to 'rejected by destination bank'. Its status refreshes to pending. No mandate is created. The simulation gives error code AP05 as example. For the full list of possible error codes, see here. You can't simulate specific error codes.
Go to the pending source's authorisation link and simulate the source to 'rejected by NPCI'. Its status refreshes to pending. No mandate is created. The simulation gives error codes 182 and 185 as examples. For the full list of possible error codes, see here. You can't simulate specific error codes.

Source (physical) simulation

Create a new source. It starts in pending status.
Upload an image and process the pending source (click Process). Its status transitions to pending_submission.
Simulate source submission. Click Simulate Submit. Select submit and click Simulate Source; its status transitions to submitted. Or select return to pending and click Simulate Source, its status transitions to pending.
Simulate the acknowledgement. Click Simulate ACK. Select Acknowledged and click Simulate Source; it creates a mandate in acknowledged status. Or select Not acknowledged and click Simulate Source; its status transitions to pending_submission.
Simulate the acknowledged mandate to active or failed. Go to the Mandate page and click Simulate. Select Accepted and click Simulate Mandate; its status transitions to active. Or select Rejected and click Simulate Mandate; its status transitions to failed.

Mandate cancel simulation

Cancel an active mandate. Its status transitions to cancelled, and its cancel_status transitions to cancel_confirmed.

Subscription simulation

Create a subscription on a mandate. If mandate is in pending status, subscription will start in pending_customer_authorisation status. If mandate has already been authorised, subscription will start in active status.
Cancel an active subscription. Subscription's status will transition to cancelled.

ACH Debit simulation

Create a new ACH debit via form, import or API. ACH debit starts in pending status.
Cancel a pending ACH debit. Its status transitions to cancelled.
Submit a pending ACH debit on the dashboard. Click Simulate. Its status transitions to submitted. Note that you can only simulate submit if the ACH debit's charge date is today or earlier. Email Support if you want to adjust future-dated debits to a past charge date, for the purpose of simulation.
Confirm a submitted ACH debit on the dashboard. Click Simulate, select confirmed, then click Continue. Its status transitions to confirmed. If you're using our nodal account, observe how one or more confirmed ACH debits create a settlement.
Reject a submitted ACH debit on the dashboard. Click Simulate, select rejected, then click Continue. Its status transitions to rejected.
Return a submitted ACH debit on the dashboard. Click Simulate, select returned, then click Continue. Its status transitions to returned.
Extend a submitted ACH debit on the dashboard. Click Simulate, select extended, then click Continue. Its status transitions to extended. An extended debit can again be simulated.

Plan simulation

Create a plan (automatic type) and invite customers to subscribe to it.
Activate the created mandate. Cancel the plan. Its status transitions to cancelled. The linked mandates will transition to cancelled.

Settlement simulation

Pay out the settlement on the dashboard. Click Simulate. Its status transitions to settled.