Skip to content

Pay Bills v2

An endpoint that will allow the integrator to pay on specific biller with additional reference details.

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

POST/pay/v2?passThrough=false

Pay Bills v2

Pay Bills Header and Query Parameters!

Pay Bills Request Body Parameters!

Request Samples

curl
    -L -X POST 'https://test-api.billeroo.com/pay/v2?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    --data-raw '{
    "merchantReference": "{merchantReference}",
    "timeOffset": "+08:00",
    "biller": "{jwtString}",
    "paymentDate": "yyyy-mm-dd hh:mm:ss +00:00",
    "fields": [
        {
            "field": "1",
            "value": "{referenceNumber}"
        },
        {
            "field": "2",
            "value": "{amount}"
        },
        {
            "field": "3",
            "value": "{countryCode}"
        },
        {
            "field": "4",
            "value": "{referenceDetails}"
        },
        {
            "field": "5",
            "value": "{email}"
        }
    ],
    "notify": {
        "customer": [
            "{string}"
        ],
        "merchant": [
            "{string}"
        ]
    },
    "customParameters": {
        }
    }'
{
    "merchantReference": "{merchantReference}",
    "timeOffset": "+08:00",
    "biller": "{jwtString}",
    "paymentDate": "yyyy-mm-dd hh:mm:ss +00:00",
    "fields": [
        {
            "field": "1",
            "value": "{referenceNumber}"
        },
        {
            "field": "2",
            "value": "{amount}"
        },
        {
            "field": "3",
            "value": "{countryCode}"
        },
        {
            "field": "4",
            "value": "{referenceDetails}"
        },
        {
            "field": "5",
            "value": "{email}"
        }
    ],
    "notify": {
        "customer": [
            "{string}"
        ],
        "merchant": [
            "{string}"
        ]
    },
    "customParameters": {
    }
}


200 Successful Response

Pay Bills v2 Response Parameters!

401 Erroneous Response

Pay Bills v2 401 Erroneous Response Parameters!

405 Erroneous Response

Pay Bills v2 405 Erroneous Response Parameters!

Response Samples

{
    "timestamp": "2024-11-08 02:51:48 +0000",
    "status": 200,
    "message": "OK",
    "path": "/pay/v2",
    "data": {
        "reference": "B241108025145XN1192O",
        "statusDescription": "Payment Posted",
        "statusCode": "OK.00.05"
    }
}
{
    "timestamp": "2024-11-08 03:52:37 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/pay/v2"
}
{
    "timestamp": "2024-11-08 03:51:57.715 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/pay/v2"
}