Get Top-up Provider Promos

An endpoint to get all availabe top-up providers.

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

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

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

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

Top-up Provider Promos

Request Samples

curlcurl detailed

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

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

200 Successful Response

200 Successful Response for Detailed Top-up Provider

401 Erroneous Response

Response Samples

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

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

{
    "timestamp": "2024-11-13 02:18:19 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up/provider",
    "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 02:23:41 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/top-up/provider"
}