Pay Bills

An endpoint that will allow the integrator to pay on specific biller.

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

POST/pay?passThrough=false

Pay Bills

Request Samples

ECPAY curlECPAY payloadSSS curlSSS payload

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

{
    "merchantReference": "{merchantReference}",
    "timeOffset": "+00:00",
    "biller": "{jwtString}",
    "fields": [
        {
            "field": "1",
            "value": "{accountNumber}"
        },
        {
            "field": "2",
            "value": "{identifier}"
        },
        {
            "field": "3",
            "value": "{amount}"
        },
        {
            "field": "4",
            "value": "{email}"
        }
    ],
    "notify": {
        "customer": [
            "{string}"
        ],
        "merchant": [
            "{string}"
        ]
    },
    "customParameters": {
    }
}

curl 
    -L -X POST 'https://test-api.billeroo.com/pay?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": "{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": "{email}"
        }
    ],
    "notify": {
        "customer": [
            "{string}"
        ],
        "merchant": [
            "{string}"
        ]
    },
    "customParameters": {
    }
}

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Pay Bills Successful ResponsePay Bills 401 Erroneous ResponsePay Bills 405 Erroneous Response

{
    "timestamp": "2024-11-07 05:28:01 +0000",
    "status": 200,
    "message": "OK",
    "path": "/pay",
    "data": {
        "reference": "B2411070527588HMFMKL",
        "statusDescription": "Payment Posted",
        "statusCode": "OK.00.05"
    }
}

{
    "timestamp": "2024-11-07 05:23:22 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/pay"
}

{
    "timestamp": "2024-11-07 05:22:32 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/pay"
}