API ReferenceIntegrationsKnowledge Base

Test Mode

RazorpayX test mode is a replication of RazorpayX in a sandbox environment that allows you to test all aspects of your integration before you go live.

You can test the following using test mode.

Feature

API

Dashboard

Bulk Upload

Contacts

Fund accounts

Payouts

Webhooks

Actions taken in the test mode have no consequences in your live environment. Contacts, fund accounts and payouts created in the test mode do not appear in the live environment. You can create contacts and fund accounts using real-world or dummy data.

Test mode has its own dummy balance. No real money is used in the test mode.

For example, a contact created in the test mode does not carry over to the live mode and vice versa. Payouts made to a fund account in the test mode uses funds from the test account balance, which is not real money.

This page includes:

Switch to Test Mode#

You can switch to the test mode from your Dashboard. Watch the short animation below for more information.

API Authentication#

All RazorpayX APIs are authorized using Basic Authorization, which is a combination of <YOUR_KEY_ID> and <YOUR_KEY_SECRET>.

Note:
API Keys generated in the live mode will not work in the test mode and vice versa.

The steps to generate API keys in the test mode is the same as the live environment. Watch the short animation below for more information.

Read more: Generate API Keys.

Postman Collection#

We have a Postman collection to make the integration quicker and easier. Click the Download Postman Collection button below to get started.

Note:
The above collection only contains APIs that work in test mode. This is not a list of all APIs available in RazorpayX.

For a list of all APIs available in RazorpayX, refer to the API section.

Instructions to use the Postman Collection#

  • All RazorpayX APIs are authorized using Basic Authorization. After you generate your test APIs keys, add them to Postman.
  • Some APIs in the collection require data specific to your account such as account_number, contact_id and fund_account_id either in the request body or as a query parameter.
    • For example, the payout API requires you to add the account_number (your virtual or current account number from which the amount for the payout should be deducted) and fund_account_id (the Fund Account ID to which the payout should be made).
    • These parameters are enclosed in {} in the collection. For example, {account_number}.
    • The API throws an error if these are incorrect or do not exist in your system.

Refer to the APIs section for explanations about the API parameters.

Add Funds#

Just like in the live environment, you will need to add funds in the test mode before you can make payouts. Test mode uses its own dummy balance. No real money is used in the test mode.

To add funds to your test mode, click the RazorpayX Test Balance widget → click Add Test Balance and follow the on-screen instructions.

Dummy Account Details:
The account details in the test mode are dummy details. Do not load real money to this account.

Watch the short animation below for more information.

Contacts#

To make a payout you will have to create a contact.

The table below lists the various contact actions you can perform in the test mode.

Action

API

Dashboard

Bulk Upload

Create a contact

Update a contact

x

View contact details

x

Mark as inactive

x

Read more: Create contacts using APIs.

Read more: Create contacts in bulk.

Fund Accounts#

Once you create a contact, you will have to create a fund account for the contact. You can create fund accounts in the test mode only using contacts created in the test mode. Payouts are made to the fund account linked to the contact.

The table below lists the various fund account actions you can perform in the test mode.

Action

API

Dashboard

Bulk Upload

Create a fund account

View fund account details

Mark as inactive

x

Read more: Create fund accounts using APIs.

Read more: Create fund accounts in bulk.

Payouts#

Life Cycle#

Below is the payout life cycle.

Read more: Refer to the Payout section for more details about the payout states.

Note:
Currently, Approval Workflow is not available in the test mode. This means the pending and rejected states are not available in test mode.

Actions#

The table below lists the various payout actions you can perform in the test mode.

Action

API

Dashboard

Bulk Upload

Create a payout

View payout details

x

Read more: Create contacts using APIs.

Read more: Create contacts in bulk.

Move a Payout to the Next State#

By default, payouts created in the test mode acquire the processing state. However, if you do not have sufficient balance, the payout acquires the queued state. In this case, add funds to move the payout to the processing state.

From the processing state, you will have to manually move the payout to the next state from the Dashboard. You can move it forward to any state in the payout lifecycle. Unlike the live mode, this does not happen automatically.

Refer to the short animation below for more details.

Account Statements#

The test mode has its own account statement based on transactions made in the test mode. You can view the account statement on the Dashboard or fetch details using the Transaction APIs.

Webhooks#

Watch the short animation below for details on how to set up webhooks.

The following webhook events are available in the test mode:

  • payout.queued
  • payout.initiated
  • payout.processed
  • payout.reversed
  • transaction.created

Read more: Setup Webhooks and sample payloads.