BILL PAY API

Bill Pay API is a request that will be sent to the biller portal which contains payment information that is sent from NPCI through the Biller Operating Unit

  • NPCI sends the Bill Payment Request to BOU.

  • BOU forwards the Bill Payment Request to Biller.

  • Biller sends the Bill Payment Request Acknowledgement to BOU, immediately upon receiving the request.

  • After Biller processes the request, the resulting Bill Payment Response is sent to BOU.

  • Once BOU receives the Bill Payment Response, a Bill Payment Response Acknowledgement is sent to Biller.

  • BOU forwards the Bill Payment Response to NPCI.

  • On receiving the Bill Payment Response, NPCI sends Bill Payment Status to BOU.

  • Once BOU receives the Status from NPCI, they send the corresponding notification to Biller.

Bill Pay API is a request that will be sent to the biller portal which contains payment information that is sent from NPCI through the Biller Operating Unit.

Request Parameters

The various parameters are explained below:

Expected Acknowledgement Parameters

The various parameters are explained below:

Json Formatted Request Example


    {
    "refId": "String", "txn": {
    "txnReferenceId": "String", "ts": "String",
    "type": "String",
    },
    "billerId:": "String", "customerParams": [
    {
    ],
    "additionalInfo": [
    {
    "name": "String",
    "value": "String"
    }
    ],
    "paymentMethod": { "quickPay": "String", "splitPay": "String", "offusPay": "String", "paymentMode": "String"
    },
    "amount": {
    "amt": {
    "amount": "String", "custConvFee": "String", "currency": "String"
    },
    "splitPayAmount": "String", "tags": [
    {
    "name": "String",
    "value": "String"
    }
    ]
    },
    "billerResponse": { "customerName": "String", "amount": "String",
    "dueDate": "String", "custConvFee": "String", "billDate": "String", "billNumber": "String", "billPeriod": "String", "tags": [
    {
    "name": "String",
    "value": "String"
    }
    ]
    },
    "tenantId" : "String"
    }

Json Formatted Response Example


    {
    "reason":"String",
    "code":"Integer", "status":"String"
    }

Last updated