Get Biller References List

An endpoint to get the list of biller references.

To get the list of biller references, send the following request header parameter via GET.

GET/biller/{jwtString}/reference?customerReference={customerReference}&passThrough=false

Biller References List

Request Samples

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

200 Successful Response

401 Erroneous Response

404 and 405 Erroneous Response

Response Samples

Get Biller References List ResponseGet Biller References List 401 Erroneous ResponseGet Biller Reference List 404 Erroneous ResponseGet Biller Reference List 405 Erroneous Response

{
    "timestamp": "2024-10-24 02:44:11.063 +0000",
    "status": 200,
    "message": "OK",
    "path": "/biller/{jwtString}/reference",
    "data": [
        {
            "billerReference": "SF240002935539",
            "notes": [
                {
                    "note": "1",
                    "description": "Member Name",
                    "value": "TESTLN9, TESTFN9 TESTMN9"
                },
                {
                    "note": "2",
                    "description": "SS Number",
                    "value": "0999999992"
                },
                {
                    "note": "3",
                    "description": "Amount",
                    "value": "2000.00"
                },
                {
                    "note": "4",
                    "description": "Applicable Month(Start)",
                    "value": "062024"
                },
                {
                    "note": "5",
                    "description": "Applicable Month(End)",
                    "value": "062024"
                }
            ]
        }
    ]
}

{
    "timestamp": "2024-10-24 04:59:37 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/biller/{jwtString}/reference"
}

{
    "timestamp": "2024-10-24T05:03:39.166+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/biller/{jwtString}/reference"
}

{
    "timestamp": "2024-10-24 05:01:15.921 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/biller/{jwtString}/reference"
}