Get Biller Requirements v2

An endpoint to get the biller requirements of pay bills version 2.

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

GET/biller/{jwtString}/v2?passThrough=false

Biller Requirements v2

Request Samples

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

200 Successful Response

401 Erroneous Response

404 and 405 Erroneous Response

Response Samples

Biller Requirements v2 ResponseBiller Requirements v2 401 Erroneous ResponseBiller Requirements v2 404 Erroneous ResponseBiller Requirements v2 405 Erroneous Response

{
    "timestamp": "2024-10-25 08:20:33.850 +0000",
    "status": 200,
    "message": "OK",
    "path": "/biller/{jwtString}/v2",
    "data": {
        "fields": [
            {
                "field": "1",
                "description": "14 Digit PRN / 22 Digit BRN",
                "format": "Alphanumeric",
                "size": "14 / 22"
            },
            {
                "field": "2",
                "description": "Amount",
                "format": "Numeric",
                "size": "9"
            },
            {
                "field": "3",
                "description": "Country Code",
                "format": "Alphabetic",
                "size": "2/3"
            },
            {
                "field": "4",
                "description": "Reference Details",
                "format": "Json Format",
                "size": "N/A"
            },
            {
                "field": "5",
                "description": "Email(Optional)",
                "format": "Email Address Format",
                "size": "N/A"
            }
        ],
        "notes": [
            {
                "note": "1",
                "description": "Convenience Fee",
                "value": "0.00"
            },
            {
                "note": "2",
                "description": "Reminder",
                "value": "2-String / 3-String ISO Country Code. Alpha-2 Code or Alpha-3 Code"
            },
            {
                "note": "3",
                "description": "Reminder",
                "value": "Reference Details can be obtained from 'Get Biller Reference Details' endpoint"
            },
            {
                "note": "4",
                "description": "PRN",
                "value": "Payment Reference Number"
            },
            {
                "note": "5",
                "description": "BRN",
                "value": "Biller Reference Number"
            }
        ]
    }
}

{
    "timestamp": "2024-10-25 08:20:08 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/biller/{jwtString}/v2"
}

{
    "timestamp": "2024-10-25 08:11:40.387+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/biller/{jwtString}/v2"
}

{
    "timestamp": "2024-10-25 08:19:22.391 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/biller/{jwtString}/v2"
}