Skip to content

Get Top-up Promo Requirements

An endpoint to get specific top-up provider requirements.

To get top-up provider requirements, send the following request header parameter via GET.

GET/top-up/{jwtString}?passThrough=false

Top-up Promo Requirements

Get Top-up Promo Requirements Header and Query Parameters!

Request Samples

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


200 Successful Response

Get Top-up Promo Requirements Response Parameters!

401 Erroneous Response

Get Top-up Promo Requirements 401 Erroneous Response Parameters!

Response Samples

{
    "timestamp": "2024-11-14 02:04:38 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up/{jwtString}",
    "data": {
        "fields": [
            {
                "field": "1",
                "description": "11 Digit - Mobile Number",
                "format": "Numeric",
                "size": "11"
            },
            {
                "field": "2",
                "description": "Email(Optional)",
                "format": "Email Address Format",
                "size": "N/A"
            }
        ],
        "notes": [
            {
                "note": "1",
                "description": "Amount for COMBO10",
                "value": "10"
            },
            {
                "note": "2",
                "description": "Promo's Provider",
                "value": "GLOBE"
            }
        ]
    }
}
{
    "timestamp": "2024-11-14 02:06:37 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/top-up/{jwtString}"
}