Skip to main content

BBPS APIs

This document describes APIs for integrating with a fetch & pay system like BBPS.

Authentication​

This API is protected using OAuth. Read our authenticaion section here

Get bill API​

This API provides pending bill details

Request​

Headers

KeyValue
AuthorizationBearer <access_token>
Content-Type:application/json
{
    "loan_number": "10935351"
}

Response​

Success​

{
  "status": "SUCCESS",
  "message": "Customer found",
  "bill": {
    "customer_name": "Ashok Kumar",
    "amount_pending": "1290.20",
    "due_date": "21-12-2020",
    "additional_items": [
      {
        "name": "name1",
        "value": "value1"
      },
      {
        "name": "name2",
        "value": "value2"
      }
    ]
  }
}

Failure - Customer not found​

{
  "status": "BFR001",
  "message": "customer-not-found"
}

Failure - No amount due​

{
  "status": "BFR004",
  "message": "no-pending-bill"
}

Payment API​

This API would be used to update a payment by you.

Request​

Headers

KeyValue
AuthorizationBearer <access_token>
Content-Type:application/json
{
    "loan_number": "10935351",
    "amount_paid": "900",
    "txn_id": "AX09812J812",
    "txn_date": "2020-02-01",
    "payment_mode": "UPI"
}

Response​

Success​

{
    "status": "SUCCESS",
    "ack": "1AJI1344"
}

Failure - Can not process payment​

{
    "status": "FAILURE",
    "message": "cannot-process-payment"
}