Get Top-up Provider Promos

An endpoint to get all available top-up providers with promos.

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

Get Top-up Provider PromosGet Detailed Top-up Provider PromosGet Categorized Top-up Provider Promos

GET/top-up/provider-promos?detailed=false&expirable=true&passThrough=false

GET/top-up/provider-promos?detailed=true&expirable=true&passThrough=false

GET/top-up/provider-promos?provider={providerName}&detailed=false&expirable=true&passThrough=false

Top-up Provider Promos

Request Samples

curlcurl detailedcurl categorized

curl 
    -L -X GET 'https://test-api.billeroo.com/top-up/provider-promos?detailed=false&expirable=true&passThrough=false' \
    -H 'Authorization: {integratorToken}'

curl 
    -L -X GET 'https://test-api.billeroo.com/top-up/provider-promos?detailed=true&expirable=true&passThrough=false' \
    -H 'Authorization: {integratorToken}'

curl
    -L -X GET 'https://test-api.billeroo.com/top-up/provider-promos?provider={providerName}&detailed=false&expirable=true&passThrough=false' \
    -H 'Authorization: {integratorToken}'

200 Successful Response

200 Successful Response for Detailed Top-up Provider Promos

401 Erroneous Response

Response Samples

Top-up Provider Promos ResponseDetailed Top-up Provider Promos ResponseCategorized Top-up Provider Promos ResponseTop-up Provider Promos 401 Erroneous Response

{
    "timestamp": "2024-11-13 07:13:11 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up/provider-promos",
    "data": [
        {
            "code": "{jwtString}",
            "value": "{promoCode}",
            "imageUrl": "{imageUrl}",
            "providerName": "{providerName}"
        }
    ]
}

{
    "timestamp": "2024-11-13 05:42:23 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up/provider-promos",
    "data": [
        {
            "code": "{jwtString}",
            "value": "{promoCode}",
            "imageUrl": "{imageUrl}",
            "providerName": "{providerName}",
            "fields": [
                {
                    "field": "{numeric}",
                    "description": "{description}",
                    "format": "{format}",
                    "size": "{numeric}"
                }
            ],
            "notes": [
                {
                    "note": "{numeric}",
                    "description": "{description}",
                    "value": "{numeric}"
                }
            ]
        }
    ]
}

{
    "timestamp": "2024-11-13 07:24:47 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up/provider-promos",
    "data": [
        {
            "code": "{jwtString}",
            "value": "{promoCode}",
            "imageUrl": "{imageUrl}",
            "providerName": "GLOBE"
        },
        {
            "code": "{jwtString}",
            "value": "{promoCode}",
            "imageUrl": "{imageUrl}",
            "providerName": "GLOBE"
        },
    ]
}

{
    "timestamp": "2024-11-13 07:21:51 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/top-up/provider-promos"
}