API Documentation

Getting Started

Quick Setup: Login → API Settings → Enter your Exchange Recharge credentials → Test Connection → Start recharging!

Sign up on Bigpay Exchange to get your API credentials
Login to your API Settings page
Enter your API Username (registered mobile number) and API Token
Click "Test Connection" to verify your credentials
Set up your Callback URL for real-time status updates
Start processing recharges from the Recharge Terminal

Authentication

All API requests require two authentication parameters:

Parameter	Description
`username`	Your registered mobile number with Bigpay Exchange
`api_token`	Your API token (available in your Bigpay Exchange dashboard)

Security: Never share your API token. Keep it confidential. Regenerate if compromised.

Recharge API

GET


                            https://www.exchangerecharge.com/webservices/api/recharge?username=[username]&api_token=[api_token]&number=[number]&amount=[amount]&operator=[operator_code]&ref_id=[your_ref_id]

Request Parameters

Parameter	Type	Required	Description
`username`	String	Yes	Your registered mobile number
`api_token`	String	Yes	Your API authentication token
`number`	String	Yes	Mobile number or subscriber ID to recharge
`amount`	Integer	Yes	Recharge amount in INR
`operator`	String	Yes	Operator code (see Operator Codes)
`ref_id`	String	Yes	Your unique reference ID for tracking (must be unique per request)

Success Response

{
    "status": "Success",
    "number": "9876543210",
    "amount": "199",
    "operator": "JIO",
    "ref_id": "RCH20260819001",
    "txn_id": "EXR123456789",
    "opt_id": "OPT987654321",
    "margin_amount": "4.50",
    "message": "Recharge successful",
    "balance": "5420.00"
}

Response Parameters

Parameter	Description
`status`	Transaction status: `Success`, `Failure`, `Pending`, `Refunded`, `Error`
`number`	Mobile number that was recharged
`amount`	Recharge amount
`operator`	Operator code
`ref_id`	Your reference ID
`txn_id`	Bigpay Exchange transaction ID
`opt_id`	Operator transaction ID
`margin_amount`	Commission earned on this transaction
`balance`	Your remaining wallet balance
`message`	Additional message from the API

Callback URL (Webhook)

Set your callback URL in API Settings. Exchange Recharge will send real-time status updates to this URL.


                            GET [YOUR_CALLBACK_URL]?number=&amount=&txnId=&refId=&status=&operatorId=&operatorCode=&balance=&margin_amount=

Callback Parameters

Parameter	Description
`number`	Mobile number that was recharged
`amount`	Recharge amount
`txnId`	Bigpay Exchange transaction ID
`refId`	Your reference ID
`status`	Updated status: `Success`, `Failure`, `Refunded`
`operatorId`	Operator transaction reference
`operatorCode`	Operator code (e.g., JIO, AT)
`balance`	Your updated wallet balance
`margin_amount`	Commission earned

Auto-configured: Bigpay Exchange automatically generates your callback URL. Go to API Settings and click "Generate Callback URL".

Status Check API

GET


                            https://www.exchangerecharge.com/webservices/api/statusByRefId?username=[username]&api_token=[api_token]&ref_id=[ref_id]&recharge_date=[YYYY-MM-DD]

Request Parameters

Parameter	Type	Required	Description
`username`	String	Yes	Your registered mobile number
`api_token`	String	Yes	Your API token
`ref_id`	String	Yes	Your reference ID from the recharge request
`recharge_date`	String	Yes	Date of the recharge in `YYYY-MM-DD` format

Response

{
    "status": "Success",
    "number": "9876543210",
    "amount": "199",
    "operator": "JIO",
    "ref_id": "RCH20260819001",
    "txn_id": "EXR123456789",
    "opt_id": "OPT987654321",
    "margin_amount": "4.50",
    "balance": "5420.00",
    "message": ""
}

Balance API

GET


                            https://www.exchangerecharge.com/webservices/api/balance?username=[username]&api_token=[api_token]

Response

{
    "status": "Success",
    "buyerBalance": "5420.00",
    "sellerBalance": "0.00",
    "lienBalance": "199.00",
    "message": ""
}

Field	Description
`buyerBalance`	Available balance for making recharges
`sellerBalance`	Balance from selling services (if applicable)
`lienBalance`	Amount held for pending transactions

Complaint API

GET


                            https://www.exchangerecharge.com/webservices/api/complain?username=[username]&api_token=[api_token]&txn_id=[txn_id]&reason=[reason]

Request Parameters

Parameter	Type	Required	Description
`username`	String	Yes	Your registered mobile number
`api_token`	String	Yes	Your API token
`txn_id`	String	Yes	Bigpay Exchange transaction ID
`reason`	String	Yes	Reason for complaint

Response

{
    "status": "Success",
    "message": "Complaint registered successfully",
    "complain_id": "CMP123456"
}

Operator Codes

Mobile Operators

Operator	Code
Jio	`JIO`
Airtel	`AT`
Vi (Vodafone Idea)	`VI`
BSNL	`BSNL`
BSNL Special	`BSNLSTV`

DTH Operators

Operator	Code
Airtel DTH	`ATDTH`
Dish TV	`DISHTV`
Sun Direct	`SUNDTH`
Tata Play (Tata Sky)	`TATASKY`
Videocon D2H	`VDDTH`

Status Codes

Status	Badge	Description	Action
`Success`	Success	Recharge completed successfully	Commission credited to wallet
`Pending`	Pending	Recharge is being processed by the operator	Wait for callback or check status manually
`Failure`	Failed	Recharge failed at operator end	Amount auto-refunded to wallet
`Refunded`	Refunded	Transaction amount has been refunded	Amount credited back to wallet
`Error`	Error	API error (invalid params, auth failure, etc.)	Check parameters and retry

Webhook Setup on Bigpay Exchange

Bigpay Exchange automatically handles webhook callbacks. Here's how it works:

Configure API

Enter your Exchange Recharge credentials in API Settings

Generate Callback

Click "Generate Callback URL" to get your unique webhook endpoint

Auto Processing

Status updates auto-processed: refunds on failure, commission on success

Your Callback URL Format

https://exchange.bigpayindia.in/api/webhook/callback/{your-user-id}

Tip: Copy this callback URL and paste it in your Bigpay Exchange dashboard under "API Settings → Callback URL".

Error Handling & Best Practices

Do

Always use unique ref_id per request
Check status via API if callback not received
Handle all status codes gracefully
Monitor your API balance regularly
Keep your API credentials secure

Don't

Don't retry without checking status first
Don't reuse ref_id for different transactions
Don't ignore Pending status responses
Don't process recharge if balance is insufficient
Don't expose API credentials in frontend code

Need Help?

If you face any issues with API integration:

Raise Support Ticket Contact Us

Navigation

Getting Started

Authentication

Recharge API

Request Parameters

Success Response

Response Parameters

Callback URL (Webhook)

Callback Parameters

Status Check API

Request Parameters

Response

Balance API

Response

Complaint API

Request Parameters

Response

Operator Codes

Mobile Operators

DTH Operators

Status Codes

Webhook Setup on Bigpay Exchange

Configure API

Generate Callback

Auto Processing

Your Callback URL Format

Error Handling & Best Practices

Do

Don't

Need Help?