Top-up

An endpoint that will allow the integrator to top-up specific providers' promo.

Depending on the top-up provider to be used. To top-up, send the request headers and body parameters via POST.

Get Top-up

POST/top-up?passThrough=false

Top-up

Request Samples

curlpayload

curl
    -L -X POST 'https://test-api.billeroo.com/top-up?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    --data-raw '{
        "merchantReference":"{merchantReference}",
        "timeOffset":"+08:00",
        "promo":"{jwtString}",
        "fields":[
            {
                "field":"1",
                "value":"{mobileNumber}"
            },
            {
                "field":"2",
                "value":"{email}"
            }
        ],
        "notify":{
            "customer":[
                "{string}"
            ],
            "merchant":[
                "{string}"
            ]
        },
        "customParameters": {
        }
    }'

{
    "merchantReference":"{merchantReference}",
    "timeOffset":"+08:00",
    "promo":"{jwtString}",
    "fields":[
        {
            "field":"1",
            "value":"{mobileNumber}"
        },
        {
            "field":"2",
            "value":"{email}"
        }
    ],
    "notify":{
        "customer":[
            "{string}"
        ],
        "merchant":[
            "{string}"
        ]
    },
    "customParameters": {
    }
}

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Top-up Successful ResponseTop-up 401 Erroneous ResponseTop-up 405 Erroneous Response

{
    "timestamp": "2024-11-14 02:28:42 +0000",
    "status": 200,
    "message": "OK",
    "path": "/top-up",
    "data": {
        "reference": "B241114022839V716C1U",
        "statusDescription": "Payment Posted",
        "statusCode": "OK.00.05"
    }
}

{
    "timestamp": "2024-11-14 02:58:40 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/top-up"
}

{
    "timestamp": "2024-11-14 03:00:10.351 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Promo Code",
    "path": "/top-up"
}