Sandbox credentials
Agent IDs and device block values for each supported initiating channel.
Test billers
How to identify customer input parameters for any biller and how to use the auto bill simulator.
End-to-end flow
Step-by-step instructions to complete a full bill payment cycle in the sandbox environment.
Sandbox credentials
Use the agent IDs below when constructing sandbox requests. Each agent ID is pre-configured for a specific initiating channel.Device block values
The device block must match the tag requirements of the initiating channel. Use the values below when building sandbox requests.- INTB — Internet Banking (Post-login)
- MOBB — Mobile Banking (Post-login)
Pass the following tags in the
agent.device.tag array for the INTB channel.For the Bill Fetch Request API, the same values apply but are passed as named fields directly under
agent_device_info (for example, init_channel, ip, mac) rather than as a tag array. The tag array format applies to the Bill Payment Request API.Test billers
Finding customer input parameters
Each biller requires a specific set of customer identifiers to initiate a bill fetch. To find the correct parameters for a biller, call the Fetch Billers Info API and read thebiller_customer_params field in the response. This field lists all the input parameter names and their expected formats that must be passed in the input_params block of the Bill Fetch Request.
Auto bill simulator
For the Loan Repayment category, a built-in auto bill simulator is available in the sandbox environment. Instead of supplying real customer identifiers, passCF_AUTO_GENERATE as the value for any input parameter. The system automatically generates a bill and returns a ref_id that you can use to poll the Bill Fetch Response API.
Use the following biller to test the auto bill simulator:
End-to-end sandbox testing
The following steps walk you through a complete BBPS COU bill payment cycle in the sandbox environment using the auto bill simulator.1
Initiate a bill fetch
Call the Bill Fetch Request API using your sandbox credentials. Use biller ID
SWAR00027NAT2J and pass CF_AUTO_GENERATE as the value for all input parameters in the input_params block.A successful request returns a ref_id. Store this value — you will need it to poll the bill fetch response and to submit the bill payment request.2
Poll the bill fetch response
Call the Bill Fetch Response API using the
ref_id from Step 1. Poll at regular intervals until the response returns a terminal status.Once successful, note the biller_response object and the additional_info field from the response. You must pass both of these fields exactly as received into the Bill Payment Request in Step 4.3
Complete the payment transaction
Use Cashfree DevStudio to complete the payment leg of the transaction in the sandbox environment. Once the payment is complete, DevStudio returns a Cashfree payment ID (
cf_payment_id). Store this value — it is required as the pg_reference_id in the next step.4
Submit the bill payment request
Call the Bill Payment Request API with the following data:
- Under
head, setbill_fetch_ref_idto theref_idfrom Step 1 and setpg_reference_idto thecf_payment_idreceived from DevStudio in Step 3. - Pass the
biller_responseobject exactly as received from the Bill Fetch Response in Step 2. - Pass the
additional_infofield exactly as received from the Bill Fetch Response in Step 2.
transaction_ref_id. Store this value along with the bill_fetch_ref_id to poll for the final payment status.5
Poll the bill payment response
Call the Bill Payment Response API using both the
bill_fetch_ref_id from Step 1 and the transaction_ref_id from Step 4. Poll at regular intervals until data.status returns success or failed.A success status confirms that the end-to-end BBPS COU transaction completed successfully in the sandbox environment.Complete all integration testing in the sandbox environment before deploying to production. For help with errors encountered during testing, refer to the BBPS COU error codes page.