Search Bill By Query Parameters

Testing Env

https://sandbox.paypoint.blackkonnect.io/services/blackkonnectpaypointswitch

GET

/api/bill-payments/bill-enquiry

Maintainer:Not configured

Retrieve list of bills details associated with the customer or based on a query criteria

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Header Params

Responses

🟢200OK

application/json

Bills company details successfully retrieved.

Body

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://sandbox.paypoint.blackkonnect.io/services/blackkonnectpaypointswitch/api/bill-payments/bill-enquiry?sourceId&billReference' \
--header 'X-Request-ID;' \
--header 'X-ServiceAccount-ID;' \
--header 'X-Organisation-ID;' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Example 1

{
    "bills": [
        {
            "billCustomerEntity": {
                "fullName": "string",
                "firstName": "string",
                "lastName": "string",
                "identityNumber": "string",
                "taxNumber": "string",
                "vatNumber": "string",
                "email": "string",
                "contactNumber": "string",
                "comments": "string",
                "customerReference": "string"
            },
            "billCompanyDetail": {
                "id": "1",
                "companyCode": "550001",
                "billerCode": "550001",
                "companyDescription": "Airtel",
                "serviceProvided": "TELECOM",
                "serviceProvidedDescription": "Mobile",
                "category": "POSTPAID",
                "categoryDescription": "Post paid",
                "subCategory": "2GBDownload",
                "subCategoryDescription": "2GB per day",
                "furtherSubCategory": "Plan1299",
                "furtherSubCategoryDescription": "Plan 1299",
                "amountInputMethod": "CUSTOMER-ENTERED",
                "supportedCurrency": "EUR",
                "isPartialAllowed": false,
                "minimumAmountAllowed": 100,
                "isExcessAllowed": false,
                "maxAmountAllowed": 100,
                "additionalDataRequired": [
                    {
                        "fieldName": "BILLALPHA1",
                        "fieldType": "ALPHANUMERIC",
                        "isMandatory": false,
                        "fieldDescription": "Consumer No"
                    }
                ],
                "lastAmendedDate": "2019-08-24",
                "allowedSourceId": [
                    {
                        "source": "BRANCH-TELLER"
                    }
                ]
            },
            "billDetail": {
                "currency": "string",
                "id": "1",
                "customerIdWithBiller": "GT5482AB",
                "reference": "C4920F94022",
                "amount": 12.99,
                "minimumAmount": 12.99,
                "maximumAmount": 12.99,
                "dueDate": "2019-08-24",
                "additionalData": [
                    {
                        "custom-fields": {
                            "property1": "string",
                            "property2": "string"
                        }
                    }
                ]
            },
            "billAccount": {
                "accountHolderName": "string",
                "nickname": "string",
                "accountReference": "string",
                "clientIdNumber": "string",
                "currencyCode": "string",
                "accountNumber": "string",
                "currentBalance": 0,
                "currentStatementBalance": 0,
                "minimumPaymentDue": 0,
                "pastAmountDue": 0,
                "nexPaymentDueDate": "2019-08-24T14:15:22Z",
                "statementDate": "2019-08-24T14:15:22Z",
                "payoffAmount": 0,
                "payoffExpiryDate": "2019-08-24T14:15:22Z",
                "organisationName": "string",
                "organisationId": "string",
                "status": "string"
            }
        }
    ]
}

Modified at 2025-07-10 05:30:41

Search Bills By Search Criteria