Validate Biller Reference

An endpoint that will allow integrator to validate reference to the biller.

Depending on the biller to be used, to validate biller reference, send the request headers and body parameters via POST.

POST/validate?passThrough=false

Validate Biller Reference

Request Samples

curlpayloadBRN curlBRN payload

curl
    -L -X POST 'https://test-api.billeroo.com/validate?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    -d '{
        "biller": "{jwtString}",
        "fields": [
            {
                "field": "1",
                "value": "{referenceNumber}"
            },
            {
                "field": "2",
                "value": "{amount}"
            },
            {
                "field": "3",
                "value": "{countryCode}"
            }
        ]
    }'

{
    "biller":"{jwtString}",
    "fields": [
        {
        "field": "1",
        "value": "{referenceNumber}"
        },
        {
        "field": "2",
        "value": "{amount}"
        },
        {
        "field": "3",
        "value": "{countryCode}"
        }
    ]
}

curl
    -L -X POST 'https://test-api.billeroo.com/validate?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    -d '{
        "biller": "{jwtString}",       
        "fields": [
            {
                "field": "1",
                "value": "{referenceNumber}"   
            },
            {
                "field": "2",
                "value": "{amount}"            
            },
            {
                "field": "3",             
                "value": "{countryCode}"
            },
            {
                "field": "4",
                "value": "{identifier}"    
            }                           
        ]
    }'

{
    "biller":"{jwtString}",
    "fields": [
        {
        "field": "1",
        "value": "{referenceNumber}"
        },
        {
        "field": "2",
        "value": "{amount}"
        },
        {
        "field": "3",
        "value": "{countryCode}"
        },
        {
        "field": "4",
        "value": "{identifier}"
        }
    ]
}

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Validate Biller Reference (ECPAY)Validate Biller Reference (SSS)Validate Biller Reference (BRN)Validate Biller Reference 401 Erroneous ResponseValidate Biller Reference 405 Erroneous Response

{
    "timestamp": "2024-11-05 06:19:27 +0000",
    "status": 200,
    "message": "OK",
    "path": "/validate",
    "data": {
        "valid": true,
        "message": "MANILAWATER"
    }
}

{
    "timestamp": "2024-11-05 06:29:00 +0000",
    "status": 200,
    "message": "OK",
    "path": "/validate",
    "data": {
        "valid": true,
        "message": "Payment Reference No. is valid"
    }
}

{
    "timestamp": "2024-11-05 05:02:18 +0000",
    "status": 200,
    "message": "OK",
    "path": "/validate",
    "data": {
        "valid": true,
        "message": "Billing Reference No. is valid"
    }
}

{
    "timestamp": "2024-11-05 06:49:17 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/validate"
}

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