Bill fetch api

API for fetching a Customer Bill, based on Biller Category, Customer Parameters etc.

Endpoint: Request: POST /couapp/bills/fetch

Request body

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

tenantId

M

Alphanumeric

Fixed Length – 4

billerId

M

Alphanumeric

Unique ID assigned to the Biller by NPCI Eg: BSNL00000NATHL

billerName

M

String

Name of the biller

billerCategory

M

String

Category of biller

clientReqId

C

String

A unique id which the client has to provide

macAdress

C

Alphanumeric

MAC Address of the Agent Server

customerMobNo

M

String

Mobile of the Customer, on whose behalf the Agent is paying the Bill

paymentChannel

M

String

Payment Channel of Agent

deviceBlockTags

M

Array of tags

Device block tags of Agent

customerParamsRequest

M

Object

Unique parameters used for identifying a Customer Bill

customerParamsRequest

tags

M

List

List of customer params

tags

name

M

String

Name of customer param

tags

value

M

String

Value of customer param

{
    "tenantId": "FE41",
    "billerId": "DKAFEE000PUN01"
    "customerParamsRequest": {
        "tags": [
            {
                "name": "Admission No/Application No/GR No",
                "value": "LF3130"
            },
            {
                "name": "Date Of Birth (DD-MM-YYYY)"
            },
            {
                "name": "Mobile No"
            }
        ]
    },
    "billerName": "Little Flower Convent School",
    "billerCategory": "Education Fees",
    "macAdress": null,
    "customerMobNo": "8281970522”,
    "paymentChannel": "Agent",
    "deviceBlockTags": [
        {
            "name": "MOBILE",
            "value": "9591810218"
        },
        {
            "name": "GEOCODE",
            "value": "28.6139,78.5555"
        },
        {
            "name": "POSTAL_CODE",
            "value": "600001"
        },
        {
            "name": "TERMINAL_ID",
            "value": "333001"
        }
    ]
}

Response body

Parent Property/Element
Property/Element Name
Mandatory
Data Type
Description

[ROOT] (No parent property / element)

billId

C

UUID

Machine-generated Unique ID for a Bill, used internally

refId

C

String

Will be null

billerId

C

String

Will be null

status

C

String

Will be null

actionType

C

String

Will be null

billerResponse

C

String

Will be null

additionalInfo

C

String

Will be null

customerParams

C

String

Will be null

creationDate

C

String

Will be null

modifiedDate

C

String

Will be null

createdEpochDate

C

String

Will be null

modifiedEpochDate

C

String

Will be null

generalResp

statusCode

M

Numeric

200- SUCCESS Other than 200-Failure

status

M

String

It is either “Success” or failure

message

M

String

Contains the reason message for failure / success

remarks

C

String

{
    "genericResponse": {
        "statusCode": "200",
        "status": "success",
        "message": "Bill Fetch Initiated",
        "remarks": ""
    },
    "billId": "1ced7566-1add-4e01-9ed6-04cd67ac9684",
    "refId": null,
    "billerId": null,
    "status": null,
    "actionType": null,
    "userId": null,
    "billerResponse": null,
    "additionalInfo": null,
    "customerParams": null,
    "creationDate": null,
    "modifiedDate": null,
    "createdEpochDate": 0,
    "modifiedEpochDate": 0
}
PreviousFETCH AND PAYNextBill Fetch by bill id api

Last updated