Skip to content

Get Biller Reference Details

An endpoint to get biller reference details.

To get biller reference details, send the following request header parameter via GET.

GET/reference/{code}/{reference}?passThrough=false

Biller Reference Details

Get Biller Reference Details Header and Query Parameters!

Request Samples

curl 
    -L -X GET 'https://test-api.billeroo.com/reference/{jwtString}/{reference}?passThrough=false' \
    -H 'Authorization: {integratorToken}'


200 Successful Response

Get Biller Reference Details Response Parameters!

401 Erroneous Response

Get Biller Reference Details 401 Erroneous Response Parameters!

404 and 405 Erroneous Response

Get Biller Reference Details 404 and 405 Erroneous Response Parameters!

Response Samples

{
    "timestamp": "2024-11-05 03:04:34.320 +0000",
    "status": 200,
    "message": "OK",
    "path": "/reference/{jwtString}/OK240003036990",
    "data": {
        "details": [
            {
                "detail": 1,
                "description": "Member Name",
                "value": "TESTLN9, TESTFN9 TESTMN9"
            },
            {
                "detail": 2,
                "description": "SS Number",
                "value": "0999999992"
            },
            {
                "detail": 3,
                "description": "Applicable Month(Start)",
                "value": "122029"
            },
            {
                "detail": 4,
                "description": "Applicable Month(End)",
                "value": "122029"
            },
            {
                "detail": 5,
                "description": "Payment Reference Number",
                "value": "OK240003036990"
            },
            {
                "detail": 6,
                "description": "Member Type",
                "value": "O"
            },
            {
                "detail": 7,
                "description": "Employee's Compensation Amount",
                "value": "0"
            },
            {
                "detail": 8,
                "description": "Regular Contribution Amount",
                "value": "1120"
            },
            {
                "detail": 9,
                "description": "Flexi-fund Amount",
                "value": "0"
            },
            {
                "detail": 10,
                "description": "Mandatory Pension Booster Amount",
                "value": "0"
            },
            {
                "detail": 11,
                "description": "Voluntary Pension Booster Amount",
                "value": "0"
            },
            {
                "detail": 12,
                "description": "Voluntary Pension Booster Flag",
                "value": "0"
            },
            {
                "detail": 13,
                "description": "Total Amount",
                "value": "1120.00"
            },
            {
                "detail": 14,
                "description": "Pro Code",
                "value": null
            },
            {
                "detail": 15,
                "description": "PDF Path",
                "value": "/testnvpfws/wispplus/OK240003036990/getPRNPdf"
            },
            {
                "detail": 16,
                "description": "Inquire Reply Date",
                "value": "2024-11-05 10:27:00.0"
            },
            {
                "detail": 17,
                "description": "Due Date",
                "value": "01/31/2030"
            }
        ]
    }
}
{
    "timestamp": "2024-11-05 03:20:46 +0000",
    "status": 200,
    "message": "OK",
    "path": "/reference/{jwtString}/051124CKQLNS",
    "data": {
        "details": [
            {
                "detail": 1,
                "description": "Billing Reference Number",
                "value": "051124CKQLNS"
            },
            {
                "detail": 2,
                "description": "Account Reference",
                "value": "SBR00001"
            },
            {
                "detail": 3,
                "description": "Description",
                "value": "Altpaynet Corp"
            },
            {
                "detail": 4,
                "description": "Amount",
                "value": "10.00"
            },
            {
                "detail": 5,
                "description": "Currency",
                "value": "PHP"
            },
            {
                "detail": 6,
                "description": "Billing Date (Start)",
                "value": "2023-12-01"
            },
            {
                "detail": 7,
                "description": "Billing Date (End)",
                "value": "2023-12-01"
            },
            {
                "detail": 8,
                "description": "Expiration",
                "value": "true"
            },
            {
                "detail": 9,
                "description": "Expiration (in minutes)",
                "value": "1"
            },
            {
                "detail": 10,
                "description": "Status",
                "value": "VALID"
            },
            {
                "detail": 11,
                "description": "Business Category Name",
                "value": "Sample ECPAY Merchant"
            }
        ]
    }
}
{
    "timestamp": "2024-11-05 03:27:18 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/reference/{jwtString}/{reference}"
}
{
    "timestamp": "2024-11-05T03:27:43.604+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/reference/{jwtString}/{reference}"
}
{
    "timestamp": "2024-11-05 03:26:21.065 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/reference/{jwtString}/{reference}"
}