Update Biller Reference

An endpoint that will allow the integrator to update the biller reference number (BRN).

To request the update of biller reference number (BRN), send the request header and body parameters via POST.

POST/update?passThrough=false

Update Biller Reference

Request Samples

curlpayload

curl
    -L -X POST 'https://test-api.billeroo.com/update?passThrough=false' \
    -H 'Authorization: {integratorToken}' \
    -H 'Content-Type: application/json' \
    -d '{
    "biller": "{jwtString}",               
    "fields": [
            {
                "field": "1",
                "value": "{BRN}"           
            },
            {
                "field": "2",
                "value": "{paymentReference}"     
            },
            {
                "field": "3",
                "value": "{amount}"                    
            },
            {
                "field": "4",
                "value": "{currencyCode}"                    
            }
        ]
    }'

{
    "biller":"{jwtString}",
    "fields": [
        {
        "field": "1",
        "value": "{BRN}"
        },
        {
        "field": "2",
        "value": "{paymentReference}"
        },
        {
        "field": "3",
        "value": "{amount}"
        },
        {
        "field": "4",
        "value": "{currencyCode}"
        }
    ]
}

200 Successful Response

401 Erroneous Response

Response Samples

Update Biller Reference Successful ResponseUpdate Biller Reference 401 Erroneous Response

{
    "timestamp": "2024-11-12 05:12:48 +0000",
    "status": 200,
    "message": "OK",
    "path": "/update",
    "data": {
        "status": "Payment posted",
        "message": "Thank you! Your payment has been posted successfully."
    }
}

{
    "timestamp": "2024-11-12 05:18:25 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/update"
}