Get Validate Requirements

An endpoint to get the validate requirement details.

To get validate requirement details, send the following request header parameter via GET.

GET/validate/{code}?passThrough=false

Validate Requirements

Request Samples

curl

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

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Get Validate Requirements ResponseGet Validate Requirements 401 Erroneous ResponseGet Validate Requirements 405 Erroneous Response

{
    "timestamp": "2024-11-06 02:34:33 +0000",
    "status": 200,
    "message": "OK",
    "path": "/validate/{jwtString}",
    "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"
            }
        ],
        "notes": [
            {
                "note": "1",
                "description": "Reminder",
                "value": "2-String / 3-String ISO Country Code. Alpha-2 Code or Alpha-3 Code"
            }
        ]
    }
}

{
    "timestamp": "2024-11-06 02:36:39 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/validate/{jwtString}"
}

{
    "timestamp": "2024-11-06 02:37:17 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/validate/{jwtString}"
}