Developer Portal

ACCESS

No Login

Public documentation aur UAT portal bina auth wall ke open hota hai.

TEST MODE

Safe Samples

Mock/sample responses ke saath onboarding aur UAT rehearsal kar sakte ho.

LIVE MODE

Real Requests

merchantId aur apiKey ke saath selected live endpoint hit kar sakte ho.

ALL ENDPOINTS

Endpoint Reference

Base URL: https://prebaird.in/api/v1. Naam pe click → full docs, "Test" → tester me load.

CATALOG APIS

GETAuth Check/api/v1/auth

GETOperators/api/v1/operators

GETCircles/api/v1/circles

GETCommissions/api/v1/commissions

RECHARGE APIS

GETBalance/api/v1/balance

GETRecharge/api/v1/recharge

GETStatus/api/v1/status

GETComplaint/api/v1/complaint

GETComplaint Status/api/v1/complaint-status

BBPS APIS

GETBill Fetch/api/v1/bill-fetch

GETBill Pay/api/v1/bill-pay

PAYOUT APIS

GETPayout/api/v1/payout

GETPayout Status/api/v1/payout-status

AUTHENTICATION

merchantid + apikey

- `merchantid` = merchant username

- `apikey` = merchant mkey

- Sabhi legacy endpoints query parameters ke through auth lete hain

- Public docs open hai, lekin live UAT ke liye valid credentials required rahenge

Example

GET https://prebaird.in/api/v1/auth?merchantid=DEMO001&apikey=DEMO123456

CATALOG APIS

Catalog APIs

GET

Auth Check

Mapped in Tester

Merchant credentials validate karne ke liye lightweight auth check endpoint.

/api/v1/auth

PARAMETERS

No endpoint-specific params.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/auth?merchantid=DEMO001&apikey=DEMO123456"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "message": "Authorized",
  "merchantid": "DEMO001"
}

GET

Operators

Operator codes aur service types fetch karne ke liye.

/api/v1/operators

PARAMETERS

type (optional) - Optional service filter जैसे Mobile, DTH, Electricity.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/operators?merchantid=DEMO001&apikey=DEMO123456&type=Mobile"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "data": [
    {
      "operatorcode": "AT",
      "operatorname": "Airtel Prepaid",
      "type": "Mobile"
    },
    {
      "operatorcode": "JIO",
      "operatorname": "Jio Prepaid",
      "type": "Mobile"
    },
    {
      "operatorcode": "VF",
      "operatorname": "Vi Prepaid",
      "type": "Mobile"
    },
    {
      "operatorcode": "BSNL",
      "operatorname": "BSNL Topup",
      "type": "Mobile"
    },
    {
      "operatorcode": "MTNL",
      "operatorname": "MTNL Delhi",
      "type": "Mobile"
    }
  ]
}

GET

Circles

Circle lookup for recharge and catalog screens.

/api/v1/circles

PARAMETERS

q (optional) - Optional search text.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/circles?merchantid=DEMO001&apikey=DEMO123456&q=Delhi"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "data": [
    {
      "circlecode": 5,
      "circlename": "Delhi"
    }
  ]
}

GET

Commissions

Operator wise commission slabs dekhne ke liye.

/api/v1/commissions

PARAMETERS

operatorcode (optional) - Optional operator code filter.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/commissions?merchantid=DEMO001&apikey=DEMO123456&operatorcode=AT"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "data": [
    {
      "operatorcode": "AT",
      "operatorname": "Airtel Prepaid",
      "comitype": 2,
      "comi": 2.5
    }
  ]
}

RECHARGE APIS

Recharge APIs

GET

Balance

Main wallet balance fetch karne ke liye.

/api/v1/balance

PARAMETERS

No endpoint-specific params.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/balance?merchantid=DEMO001&apikey=DEMO123456"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "balance": "24500.00",
  "message": "Success"
}

GET

Recharge

Recharge order create karne ke liye.

/api/v1/recharge

PARAMETERS

operator (required) - Operator code.

circle (required) - Circle code (numeric, see Circle Codes list, e.g. 5 = Delhi).

number (required) - Customer mobile / account number.

amount (required) - Recharge amount.

txnid (required) - Unique merchant transaction id.

optional (optional) - Optional extra parameter.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/recharge?merchantid=DEMO001&apikey=DEMO123456&operator=AT&circle=5&number=1234567890&amount=199&txnid=AUTO-TXNID&optional="

SAMPLE RESPONSE

{
  "txnid": "AUTO-TXNID",
  "status": "SUCCESS",
  "number": "1234567890",
  "amount": 199,
  "optid": "RB123456",
  "operator": "AT",
  "type": "Mobile",
  "balance": "24305.00",
  "billamount": "199.00",
  "commission": "4.975",
  "message": "Payment Processed"
}

GET

Status

Recharge / payout / BBPS transaction status check karne ke liye.

/api/v1/status

PARAMETERS

txnid (required) - Merchant transaction id.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/status?merchantid=DEMO001&apikey=DEMO123456&txnid=AUTO-TXNID"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "txnid": "AUTO-TXNID",
  "type": "Mobile",
  "amount": 199,
  "refid": "RB123456",
  "number": "1234567890",
  "operator": "AT",
  "message": "Payment Processed"
}

GET

Complaint

Kisi transaction ke against complaint register karne ke liye.

/api/v1/complaint

PARAMETERS

txnid (required) - Merchant transaction id.

message (required) - Complaint message / reason.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/complaint?merchantid=DEMO001&apikey=DEMO123456&txnid=AUTO-TXNID&message=Recharge+not+received"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "message": "Complaint registered successfully",
  "complaintid": "TKT-20260617-0042",
  "complaintStatus": "Open",
  "txnid": "AUTO-TXNID"
}

GET

Complaint Status

Complaint ka status check karne ke liye (complaintid ya txnid se).

/api/v1/complaint-status

PARAMETERS

complaintid (optional) - Complaint id (ticket no). txnid ke saath ek zaroori.

txnid (optional) - Transaction id (complaintid na ho to).

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/complaint-status?merchantid=DEMO001&apikey=DEMO123456&complaintid=TKT-20260617-0042&txnid="

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "complaintid": "TKT-20260617-0042",
  "complaintStatus": "Open",
  "txnid": "AUTO-TXNID",
  "category": "API Complaint",
  "message": "Recharge not received",
  "resolution": "",
  "createdAt": "2026-06-17T10:30:00Z"
}

BBPS APIS

BBPS APIs

GET

Bill Fetch

BBPS bill detail fetch करने ke liye.

/api/v1/bill-fetch

PARAMETERS

operator (required) - BBPS operator code.

number (required) - Consumer number.

optional1 (optional) - Optional param 1.

optional2 (optional) - Optional param 2.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/bill-fetch?merchantid=DEMO001&apikey=DEMO123456&operator=ELC&number=1234567890&optional1=&optional2="

SAMPLE RESPONSE

{
  "operator": "ELC",
  "status": "SUCCESS",
  "message": "SUCCESS",
  "dueamount": "499.00",
  "dueaate": "2026-06-30",
  "customername": "Demo User",
  "billnumber": "1234567890",
  "billdate": "2026-06-01",
  "billperiod": "MAY-2026",
  "refid": "BILL12345",
  "editable": false,
  "merchantid": "DEMO001"
}

GET

Bill Pay

Fetched bill ya direct bill payment create karne ke liye.

/api/v1/bill-pay

PARAMETERS

operator (required) - BBPS operator code.

number (required) - Consumer number.

amount (required) - Bill amount.

txnid (required) - Unique merchant transaction id.

optional1 (optional) - Optional param 1.

optional2 (optional) - Optional param 2.

optional3 (optional) - Optional param 3.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/bill-pay?merchantid=DEMO001&apikey=DEMO123456&operator=ELC&number=1234567890&amount=499&txnid=AUTO-BBPS-TXNID&optional1=&optional2=&optional3="

SAMPLE RESPONSE

{
  "txnid": "AUTO-BBPS-TXNID",
  "status": "SUCCESS",
  "number": "1234567890",
  "amount": "499.00",
  "optid": "BBPSREF123",
  "vouchercode": "",
  "operator": "ELC",
  "service": "Electricity",
  "balance": "24001.00",
  "message": "Payment Processed",
  "billamount": "499.00",
  "comi": "0.000"
}

PAYOUT APIS

Payout APIs

GET

Payout

Bank payout create karne ke liye.

/api/v1/payout

PARAMETERS

txnid (required) - Unique merchant transaction id.

amount (required) - Payout amount.

account (required) - Beneficiary account number.

ifsc (required) - IFSC code.

name (required) - Account holder name.

mode (required) - IMPS / NEFT / RTGS.

bank (optional) - Optional bank name.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/payout?merchantid=DEMO001&apikey=DEMO123456&txnid=AUTO-PAYOUT-TXNID&amount=1000&account=123456789012&ifsc=HDFC0001234&name=Demo+User&mode=IMPS&bank=HDFC+Bank"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "txnid": "AUTO-PAYOUT-TXNID",
  "refid": "UTR2026061301234",
  "amount": "1000.00",
  "fees": "10.00",
  "mode": "IMPS",
  "account": "123456789012",
  "ifsc": "HDFC0001234",
  "name": "Demo User",
  "message": "Success"
}

GET

Payout Status

Payout transaction status check karne ke liye.

/api/v1/payout-status

PARAMETERS

txnid (required) - Merchant payout transaction id.

SAMPLE REQUEST

curl -X GET "https://prebaird.in/api/v1/payout-status?merchantid=DEMO001&apikey=DEMO123456&txnid=AUTO-PAYOUT-TXNID"

SAMPLE RESPONSE

{
  "status": "SUCCESS",
  "txnid": "AUTO-PAYOUT-TXNID",
  "refid": "UTR2026061301234",
  "amount": "1000.00",
  "fees": "10.00",
  "mode": "IMPS",
  "account": "123456789012",
  "ifsc": "HDFC0001234",
  "name": "Demo User",
  "message": "Success"
}

OPERATOR CODES

Operators (0)

Operator	Code	Type	Optional1	Optional2
Loading operators…

CIRCLE CODES

Circles (0)

Circle Code	Circle Name
Loading circles…

UAT TEST SYSTEM

Interactive Tester

Test mode sample देता hai, live mode selected real endpoint hit karta hai.

Mapped API: Auth Check

Endpoint

Live mode me selected endpoint real `/api/v1/*` route hit karega. Merchant IP whitelist ya backend restrictions applicable rahengi.

REQUEST PREVIEW

https://prebaird.in/api/v1/auth?merchantid=DEMO001&apikey=DEMO123456

SAMPLE RESPONSES

SUCCESS

{
  "status": "SUCCESS",
  "message": "SUCCESS",
  "merchantid": "DEMO001"
}

FAILED

{
  "status": "FAILED",
  "message": "Request failed",
  "merchantid": "DEMO001"
}

PENDING

{
  "status": "PENDING",
  "message": "Request pending",
  "merchantid": "DEMO001"
}

RESPONSE

{
  "status": "SUCCESS",
  "message": "Authorized",
  "merchantid": "DEMO001"
}

WEBHOOK NOTES

Callback / Webhook

- Callback URL live merchant profile se configure hota hai.

- Statuses typically SUCCESS, FAILED aur PENDING ke saath push hote hain.

- Webhook testing ke liye pehle test mode se request format validate karo.

- Live mode me actual merchant config aur IP restrictions apply hongi.

ERROR CODES

Common Responses

Code	Description
SUCCESS	Request accepted ya processed successfully.
FAILED	Validation, balance, routing ya provider side failure.
401	Invalid merchant credentials ya unauthorized request.
422	Required params missing ya malformed request.
500	Unexpected internal server or provider processing issue.

Developer Documentation & UAT

Endpoint Reference

merchantid + apikey

Catalog APIs

Auth Check

Operators

Circles

Commissions

Recharge APIs

Balance

Recharge

Status

Complaint

Complaint Status

BBPS APIs

Bill Fetch

Bill Pay

Payout APIs

Payout

Payout Status

Operators (0)

Circles (0)

Interactive Tester

Callback / Webhook

Common Responses