Generate Biller Reference

An endpoint to generate biller reference number (BRN) for specific biller.

To generate BRN, send the following request header parameter via POST.

POST/generate?passThrough=false

Generate Biller Reference

Request Samples

SSS curlSSS payloadBRN curlBRN payload

curl -L -X POST 'https://test-api.billeroo.com/generate?passThrough=false' \
-H 'Authorization: {integratorToken}' \
-H 'Content-Type: application/json' \
-d '{
        "biller": "{jwtString}",
        "fields": [
            {
            "field": "1",
            "value": "2"
            },
            {
            "field": "2",
            "value": "0999999992"
            },
            {
            "field": "3",
            "value": "560"
            },
            {
            "field": "4",
            "value": "0"
            },
            {
            "field": "5",
            "value": "082026"
            },
            {
            "field": "6",
            "value": "082026"
            },
            {
            "field": "7",
            "value": "0"
            }
        ]
    }'

{
    "biller": "{jwtString}",
    "fields": [
        {
        "field": "1",
        "value": "2"
        },
        {
        "field": "2",
        "value": "0999999992"
        },
        {
        "field": "3",
        "value": "560"
        },
        {
        "field": "4",
        "value": "0"
        },
        {
        "field": "5",
        "value": "102024"
        },
        {
        "field": "6",
        "value": "102024"
        },
        {
        "field": "7",
        "value": "0"
        }
    ]
}

curl -L -X POST 'https://test-api.billeroo.com/generate?passThrough=false' \
-H 'Authorization: {integratorToken}' \
-H 'Content-Type: application/json' \
-d '{
        "biller": "{jwtString}",           
        "fields": [
            {
            "field": "1",                         
            "value": "SBR00001"
            },
            {
            "field": "2",                         
            "value": "Altpaynet Corp"
            },
            {
            "field": "3",
            "value": "300"                         
            },
            {
            "field": "4",
            "value": "PHP"                        
            },
            {
            "field": "5",
            "value": "true"                      
            },
            {
            "field": "6",
            "value": "1"                          
            },
            {
            "field": "7",
            "value": "2023-12-01"                 
            },
            {
            "field": "8",
            "value": "2023-12-01"                 
            }
        ]
    }'

{
    "biller": "{jwtString}",
    "fields": [
        {
        "field": "1",
        "value": "BLR00001"
        },
        {
        "field": "2",
        "value": "AltPayNet Corp"
        },
        {
        "field": "3",
        "value": "300"
        },
        {
        "field": "4",
        "value": "PHP"
        },
        {
        "field": "5",
        "value": "true"
        },
        {
        "field": "6",
        "value": "1"
        },
        {
        "field": "7",
        "value": "2024-11-01"
        },
        {
        "field": "8",
        "value": "2024-12-01"
        }
    ]
}

200 Successful Response

401 Erroneous Response

404 and 405 Erroneous Response

Response Samples

Generate Biller ReferenceGenerate Biller Reference 401 Erroneous ResponseGenerate Biller Reference 404 Erroneous ResponseGenerate Biller Reference 405 Erroneous Response

{
    "timestamp": "2022-12-06 02:56:31 +0000",
    "status": 200,
    "message": "OK",
    "path": "/generate",
    "data": {
        "reference": "{reference}",
        "message": "Successfully generated"
    }
}

{
    "timestamp": "2022-12-03 07:29:48 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/generate"
}

{
    "timestamp": "2024-10-28 07:45:56.811+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/generate"
}

{
    "timestamp": "2024-10-28 07:43:25.886 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/generate"
}