Bill Payment · BBPS

BBPS Bill Fetch

Fetch utility bill details

POST request

URL: https://uat-api.vizodigital.com/api/v1/bill-payment/bbps/bill-fetch

Body

{
    "mobile": "9876543210",
    "opcode": "BRPL",
    "consumer_number": "1001234567",
    "orderid": "BBPS_FETCH_001"
}

Include a valid Bearer token with every request

Code sample

curl -X POST "https://uat-api.vizodigital.com/api/v1/bill-payment/bbps/bill-fetch" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "mobile": "9876543210",
    "opcode": "BRPL",
    "consumer_number": "1001234567",
    "orderid": "BBPS_FETCH_001"
  }'

Success response

{
    "status": "success",
    "message": "Bill fetched successfully.",
    "data": {
        "fetch_id": "BBPSF-12-ab12cd34",
        "customer_name": "RAJESH KUMAR",
        "bill_date": "01/09/2026",
        "bill_due_date": "15/09/2026",
        "bill_amount": 1240.5,
        "minimum_due": null,
        "orderid": "BBPS_FETCH_001"
    },
    "fee": 0.1,
    "wallet_balance": 999.9
}

Failure response

{
    "status": "error",
    "message": "Request failed. Check credentials, wallet balance, or validation errors."
}

Overview

Fetch due amount and customer details for a BBPS biller.

Returns a fetch_id required by BBPS Bill Pay.

Access & billing

Enable bbps_bill_fetch under Plan API access.
Per-call fee is debited from the developer wallet; failed provider calls refund the fee.
Optional value1–value4 for biller-specific extra fields.

Body

application/json required

BBPS bill fetch body

Schema

{
    "type": "object",
    "required": [
        "mobile",
        "opcode",
        "consumer_number",
        "orderid"
    ],
    "properties": {
        "mobile": {
            "type": "string"
        },
        "opcode": {
            "type": "string"
        },
        "consumer_number": {
            "type": "string",
            "description": "Consumer / CA / account number"
        },
        "orderid": {
            "type": "string"
        },
        "value1": {
            "type": "string"
        },
        "value2": {
            "type": "string"
        },
        "value3": {
            "type": "string"
        },
        "value4": {
            "type": "string"
        }
    }
}

Example

{
    "mobile": "9876543210",
    "opcode": "BRPL",
    "consumer_number": "1001234567",
    "orderid": "BBPS_FETCH_001"
}

Responses

200 · application/json default

Bill fetched

Example

{
    "status": "success",
    "message": "Bill fetched successfully.",
    "data": {
        "fetch_id": "BBPSF-12-ab12cd34",
        "customer_name": "RAJESH KUMAR",
        "bill_date": "01/09/2026",
        "bill_due_date": "15/09/2026",
        "bill_amount": 1240.5,
        "minimum_due": null,
        "orderid": "BBPS_FETCH_001"
    },
    "fee": 0.1,
    "wallet_balance": 999.9
}

Rate Limits

60/min