API documentation
One REST API for recharge, BBPS bill payments, credit card bills, NSDL PAN, KYC verification, DigiLocker and plan lookups. JSON in, JSON out, with a free sandbox.
Getting started
- Create an account and request API access from Client area → API services.
- Create a test key and integrate against the sandbox — no charges, no operators.
- When your account is approved, add funds to your API wallet, whitelist your server IP and create a live key.
All requests use HTTPS. Send JSON with Content-Type: application/json. Amounts are in INR.
Authentication
Send your key in the X-Api-Key header (or Authorization: Bearer …). Live keys start with pk_live_, test keys with pk_test_. Keep keys on your server; never put them in a mobile app or web page.
curl https://domainsrock.demo.pepploweb.com/api/services/v1/balance \ -H "X-Api-Key: pk_test_YOUR_KEY"
Live keys work only from IP addresses you whitelist under Security & webhooks.
Signing requests (recommended)
Each key has a signing secret. Add two headers and we reject anything that was altered or replayed:
X-Timestamp— current Unix time in seconds (allowed drift: 5 minutes).X-Signature— hex HMAC-SHA256 of{timestamp}.{METHOD}.{path}.{raw body}, where path is like/api/services/v1/services/mobile-recharge.
A signature is checked whenever you send one, and is required on every live call when you (or we) turn on “Require a signature”.
Making a call
Send the service parameters plus an optional but strongly recommended client_ref — your own unique order id. Repeating a request with the same client_ref returns the original result and never charges twice.
BODY='{"operator":"A","number":"9876543210","amount":199,"client_ref":"ORDER-1001"}'
TS=$(date +%s)
SIG=$(printf "%s.POST./api/services/v1/services/mobile-recharge.%s" "$TS" "$BODY" | openssl dgst -sha256 -hmac "$API_SECRET" | sed 's/^.* //')
curl -X POST https://domainsrock.demo.pepploweb.com/api/services/v1/services/mobile-recharge \
-H "Content-Type: application/json" \
-H "X-Api-Key: $API_KEY" -H "X-Timestamp: $TS" -H "X-Signature: $SIG" \
-d "$BODY"$body = json_encode(array (
'operator' => 'A',
'number' => '9876543210',
'amount' => 199,
'client_ref' => 'ORDER-1001',
));
$ts = time();
$path = '/api/services/v1/services/mobile-recharge';
$sig = hash_hmac('sha256', "$ts.POST.$path.$body", getenv('API_SECRET'));
$ch = curl_init('https://domainsrock.demo.pepploweb.com/api/services/v1/services/mobile-recharge');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => $body,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'X-Api-Key: ' . getenv('API_KEY'),
'X-Timestamp: ' . $ts,
'X-Signature: ' . $sig,
],
]);
$result = json_decode(curl_exec($ch), true);import crypto from 'node:crypto';
const body = JSON.stringify({"operator":"A","number":"9876543210","amount":199,"client_ref":"ORDER-1001"});
const ts = Math.floor(Date.now() / 1000);
const path = '/api/services/v1/services/mobile-recharge';
const sig = crypto.createHmac('sha256', process.env.API_SECRET).update(`${ts}.POST.${path}.${body}`).digest('hex');
const res = await fetch('https://domainsrock.demo.pepploweb.com/api/services/v1/services/mobile-recharge', {
method: 'POST',
headers: { 'Content-Type': 'application/json', 'X-Api-Key': process.env.API_KEY, 'X-Timestamp': String(ts), 'X-Signature': sig },
body,
});
const result = await res.json();import hashlib, hmac, json, os, time, requests
body = json.dumps({"operator":"A","number":"9876543210","amount":199,"client_ref":"ORDER-1001"}, separators=(",", ":"))
ts = str(int(time.time()))
path = "/api/services/v1/services/mobile-recharge"
sig = hmac.new(os.environ["API_SECRET"].encode(), f"{ts}.POST.{path}.{body}".encode(), hashlib.sha256).hexdigest()
r = requests.post("https://domainsrock.demo.pepploweb.com/api/services/v1/services/mobile-recharge", data=body, headers={
"Content-Type": "application/json", "X-Api-Key": os.environ["API_KEY"], "X-Timestamp": ts, "X-Signature": sig})
result = r.json()Response
{
"success": true,
"ref": "AR7KQ2261022143005MZ4P",
"client_ref": "ORDER-1001",
"service": "mobile-recharge",
"mode": "live",
"status": "success", // success | pending | failed | refunded
"amount": 199,
"charge": 194.03, // debited from your wallet
"operator_ref": "OP12345678",
"message": "Transaction successful.",
"data": { … }, // service-specific details
"balance": 4805.97
}HTTP 200 = final result (check status), 202 = accepted and pending. Failed transactions are refunded to your wallet automatically.
Operators and billers
Recharges, bills and plan lookups take an operator code. Get the codes for a service (they rarely change, so cache them for a day):
{ "success": true, "category": "Electricity Bill", "count": 165,
"operators": [ { "code": "1720", "name": "Manipur State Power Distribution Company Limited", "bill_fetch": true }, … ] }GET https://domainsrock.demo.pepploweb.com/api/services/v1/operators without a service lists the categories; GET https://domainsrock.demo.pepploweb.com/api/services/v1/circles lists telecom circles for mobile-plans.
Some billers need extra fields: send them as value1 and value2 (the operator list tells you their labels when known).
Bill fetch and two-step services
For bills, fetch the amount due first, then pay. Credit card payments need the fetch_ref from the fetch call; for other bills it is optional.
{ "operator": "1720", "number": "058000021584" }
→ { "success": true, "action": "fetch", "status": "success",
"data": { "customer_name": "W NABA MEITEI", "bill_amount": "500.0", "due_date": "2026-08-13", "fetch_ref": "…" } }{ "operator": "1720", "number": "058000021584", "amount": 500, "fetch_ref": "…", "client_ref": "BILL-7781" }DigiLocker works the same way: POST /services/aadhaar-digilocker returns a redirect_url for the person plus verification_id and reference_id;
after they finish, POST /services/aadhaar-digilocker/document with those two IDs returns the verified details. NSDL PAN services return a redirect_url where the applicant completes the form.
Packages
Live calls work for the services included in your active package (see included_in_package in GET /services). Test keys work for every service.
Buy or change your package in the client area.
Transaction status and history
Pending transactions are re-checked with the operator automatically; poll the status endpoint or, better, use webhooks.
Webhooks
Set an https webhook URL under Security & webhooks. When a transaction becomes final we POST:
{ "event": "transaction.success", "transaction": { "ref": "…", "client_ref": "ORDER-1001", "status": "success", … } }Verify the X-Signature header: hex HMAC-SHA256 of {X-Timestamp}.{raw body} with your webhook secret. Reply with any 2xx status.
$expected = hash_hmac('sha256', $_SERVER['HTTP_X_TIMESTAMP'] . '.' . file_get_contents('php://input'), getenv('WEBHOOK_SECRET'));
if (! hash_equals($expected, $_SERVER['HTTP_X_SIGNATURE'] ?? '')) { http_response_code(401); exit; }Errors
| HTTP | error | Meaning |
|---|---|---|
| 401 | unauthenticated, invalid_key, bad_signature, bad_timestamp, replayed | Key or signature problem. |
| 402 | insufficient_balance | Add funds to your API wallet. |
| 403 | ip_not_allowed, ip_whitelist_required, ip_blocked, account_pending, service_not_allowed, package_required | Not allowed for this account, IP address or package. |
| 404 | not_found | Unknown service, endpoint or transaction. |
| 422 | validation_failed, operator_not_supported | A parameter is missing or invalid — see errors — or the operator is temporarily unavailable. |
| 429 | rate_limited, daily_limit, too_many_failures | Slow down; see the Retry-After header. |
| 503 | service_unavailable | The service is not live yet (use a test key) or temporarily unavailable. |
Sandbox
Test keys always use the sandbox. To simulate outcomes: amounts ending in .13 fail and .37 stay pending; a mobile, account or customer number ending in 0000 fails and 1111 stays pending. Everything else succeeds.
Services
Recharge
Mobile Recharge Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=mobile-recharge |
Yes | A |
numberMobile number | mobile | Yes | 9876543210 |
amount | number | Yes | ₹10.00 – ₹10,000.00 |
client_ref | text | Recommended | ORDER-1001 |
DTH Recharge Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=dth-recharge |
Yes | A |
numberSubscriber / customer ID | text | Yes | 1234567890 |
amount | number | Yes | ₹100.00 – ₹25,000.00 |
client_ref | text | Recommended | ORDER-1001 |
Google Play Recharge Code Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=google-play-voucher |
Yes | A |
numberCustomer mobile number | mobile | Yes | 9876543210 |
amount | number | Yes | ₹10.00 – ₹5,000.00 |
client_ref | text | Recommended | ORDER-1001 |
Bill payments (BBPS)
Electricity Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=electricity-bill |
Yes | A |
numberConsumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹200,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=electricity-bill |
Yes | A |
numberConsumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Postpaid Mobile Bill Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=postpaid-bill |
Yes | A |
numberMobile number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹50,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=postpaid-bill |
Yes | A |
numberMobile number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Broadband Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=broadband-bill |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹50,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=broadband-bill |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Landline Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=landline-bill |
Yes | A |
numberLandline number with STD code | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹50,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=landline-bill |
Yes | A |
numberLandline number with STD code | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Water Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=water-bill |
Yes | A |
numberConnection / consumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹100,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=water-bill |
Yes | A |
numberConnection / consumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Gas and LPG Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=gas-bill |
Yes | A |
numberCustomer / consumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹50,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=gas-bill |
Yes | A |
numberCustomer / consumer number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Cable TV Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=cable-tv-bill |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹25,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=cable-tv-bill |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Insurance Premium Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=insurance-premium |
Yes | A |
numberPolicy number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹500,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=insurance-premium |
Yes | A |
numberPolicy number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Loan EMI Repayment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=loan-repayment |
Yes | A |
numberLoan account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹500,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=loan-repayment |
Yes | A |
numberLoan account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
FASTag Recharge Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=fastag-recharge |
Yes | A |
numberVehicle number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹100.00 – ₹100,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=fastag-recharge |
Yes | A |
numberVehicle number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Municipal Tax Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=municipal-tax |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹500,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=municipal-tax |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Donation Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=donation |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
fetch_refBill fetch reference (from the fetch call) | text | No | |
amount | number | Yes | ₹10.00 – ₹100,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorBiller | operator GET /operators?service=donation |
Yes | A |
numberConsumer / account number | text | Yes | 058000021584 |
value1Extra field 1 (if the biller asks) | text | No | |
value2Extra field 2 (if the biller asks) | text | No | |
mobileCustomer mobile (for the receipt) | mobile | No | 9876543210 |
Credit Card Bill Payment Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorCard issuer | operator GET /operators?service=credit-card-bill |
Yes | A |
mobileMobile number registered with the card | mobile | Yes | 9876543210 |
cardLast 4 digits of the card | digits4 | Yes | 3008 |
fetch_refBill fetch reference (from the fetch call) | text | Yes | TSB974ca11c49f641e08b17690a43631819 |
panPAN (required from ₹50,000) | pan | No | ABCDE1234F |
amount | number | Yes | ₹100.00 – ₹200,000.00 |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorCard issuer | operator GET /operators?service=credit-card-bill |
Yes | A |
mobileMobile number registered with the card | mobile | Yes | 9876543210 |
cardLast 4 digits of the card | digits4 | Yes | 3008 |
PAN card services
New PAN Card (NSDL) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
mobileApplicant mobile number | mobile | Yes | 9876543210 |
modeApplication mode | select EKYC,ESIGN |
Yes | EKYC |
client_ref | text | Recommended | ORDER-1001 |
PAN Card Correction (NSDL) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
mobileApplicant mobile number | mobile | Yes | 9876543210 |
modeApplication mode | select EKYC,ESIGN |
Yes | EKYC |
client_ref | text | Recommended | ORDER-1001 |
Resume Incomplete PAN Application Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
application_refReference of the earlier PAN application | ref | Yes | AR1A2B261023101500XYZ1 |
client_ref | text | Recommended | ORDER-1001 |
Verification (KYC)
PAN Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
panPAN | pan | Yes | ABCDE1234F |
consentCustomer consent | consent | Yes | true |
client_ref | text | Recommended | ORDER-1001 |
PAN 360 (with Aadhaar link status) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
panPAN | pan | Yes | ABCDE1234F |
consentCustomer consent | consent | Yes | true |
client_ref | text | Recommended | ORDER-1001 |
GST Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
gstinGSTIN | gstin | Yes | 27AAPFU0939F1ZV |
client_ref | text | Recommended | ORDER-1001 |
Bank Account Verification (Advance) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
account_numberAccount number | account | Yes | 123456789012 |
ifscIFSC | ifsc | Yes | SBIN0001234 |
client_ref | text | Recommended | ORDER-1001 |
Bank Account Verification (Simple) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
account_numberAccount number | account | Yes | 123456789012 |
ifscIFSC | ifsc | Yes | SBIN0001234 |
client_ref | text | Recommended | ORDER-1001 |
Penny-less Bank Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
account_numberAccount number | account | Yes | 123456789012 |
ifscIFSC | ifsc | Yes | SBIN0001234 |
client_ref | text | Recommended | ORDER-1001 |
Penny-drop Bank Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
account_numberAccount number | account | Yes | 123456789012 |
ifscIFSC | ifsc | Yes | SBIN0001234 |
client_ref | text | Recommended | ORDER-1001 |
UPI ID Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
vpaUPI ID | upi | Yes | rahul@okbank |
client_ref | text | Recommended | ORDER-1001 |
Driving Licence Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
dl_numberDriving licence number | text | Yes | UP7020160012345 |
dobDate of birth | date | Yes | 1990-05-21 |
consentCustomer consent | consent | Yes | true |
client_ref | text | Recommended | ORDER-1001 |
Passport Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
file_numberPassport file number | text | Yes | LK1067123456789 |
dobDate of birth | date | Yes | 1990-05-21 |
consentCustomer consent | consent | Yes | true |
client_ref | text | Recommended | ORDER-1001 |
Voter ID Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
epic_numberVoter ID (EPIC) number | text | Yes | ABC1234567 |
consentCustomer consent | consent | Yes | true |
client_ref | text | Recommended | ORDER-1001 |
Vehicle RC Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
vehicle_numberVehicle number | vehicle | Yes | UP70AB1234 |
client_ref | text | Recommended | ORDER-1001 |
Company CIN Verification Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
cinCompany CIN | cin | Yes | U62099WB2023PTC260652 |
client_ref | text | Recommended | ORDER-1001 |
Card BIN Check Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
binFirst 6 digits of the card | bin | Yes | 479959 |
client_ref | text | Recommended | ORDER-1001 |
Aadhaar Verification via DigiLocker Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
redirect_urlReturn address after DigiLocker | url | Yes | https://shop.pepploweb.com/kyc/done |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
verification_idverification_id from step 1 | text | Yes | 2493170 |
reference_idreference_id from step 1 | text | Yes | 551863 |
PAN Verification via DigiLocker Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
redirect_urlReturn address after DigiLocker | url | Yes | https://shop.pepploweb.com/kyc/done |
client_ref | text | Recommended | ORDER-1001 |
| Parameter | Type | Required | Example |
|---|---|---|---|
verification_idverification_id from step 1 | text | Yes | 2493170 |
reference_idreference_id from step 1 | text | Yes | 551863 |
Plans and lookups
Mobile Operator and Circle Finder Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
mobileMobile number | mobile | Yes | 9876543210 |
client_ref | text | Recommended | ORDER-1001 |
Mobile Recharge Plans Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=mobile-plans |
Yes | A |
circleCircle | circle | Yes | DELHI |
mobileMobile number | mobile | No | 9876543210 |
client_ref | text | Recommended | ORDER-1001 |
DTH Plans Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=dth-plans |
Yes | A |
numberSubscriber ID (optional) | text | No | 07210298754 |
client_ref | text | Recommended | ORDER-1001 |
Special Offers (R-offer) for Airtel and Vi Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=r-offer |
Yes | A |
mobileMobile number | mobile | Yes | 9876543210 |
client_ref | text | Recommended | ORDER-1001 |
DTH Customer Details and Balance Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
operatorOperator | operator GET /operators?service=dth-customer-info |
Yes | A |
numberSubscriber ID | text | Yes | 07210298754 |
client_ref | text | Recommended | ORDER-1001 |
Messaging
OTP SMS (no DLT needed) Sandbox
| Parameter | Type | Required | Example |
|---|---|---|---|
mobileMobile number | mobile | Yes | 9876543210 |
otpOTP to send | otp | Yes | 482915 |
client_ref | text | Recommended | ORDER-1001 |