Simulation APIs

Simulation APIs let you move a sandbox customer, payout, incoming payment, or funding instrument through a lifecycle status. In production, compliance review, a request for information (RFI), approval, rejection, and the final transaction result happen without a manual call. In the sandbox, these APIs give you the same transitions on demand.

Use a simulation API when a test is waiting on a decision, when you need an intermediate or final status, or when you need a rejection or an asynchronous update. Invalid or out-of-order transitions are rejected. These APIs complement the business APIs. They are not used in production.

For when to use mock test data instead, see Testing Nium. For the step-by-step flows, see Testing onboarding and Testing payouts.

important

Simulation APIs work in the sandbox only.

Choose a simulation API

• Simulate v5 onboarding status changes a customer's status and subStatus after Know Your Customer (KYC).
• Simulate transaction status changes a payout status.
• Simulate an incoming payment credits a virtual account.
• Simulate funding instrument status completes or reverses a microdeposit.