Get Update Reference Requirements

An endpoint to get the details of update reference requirements.

To get the details of update reference requirements, send the following request header parameter via GET.

GET/biller/{jwtString}/update?passThrough=false

Update Reference Requirements

Request Samples

curl 
    -L -X GET 'https://test-api.billeroo.com/biller/{jwtString}/update?passThrough=false' \
    -H 'Authorization: {integratorToken}'

200 Successful Response

401 Erroneous Response

404 and 405 Erroneous Response

Response Samples

Update Reference Requirements ResponseUpdate Reference Requirements 401 Erroneous ResponseUpdate Reference Requirements 404 Erroneous Response

{
    "timestamp": "2024-10-25 05:16:56 +0000",
    "status": 200,
    "message": "OK",
    "path": "/biller/{jwtString}/update",
    "data": {
        "fields": [
            {
                "field": "1",
                "description": "Generated BRN from Generate BRN API",
                "format": "Alphanumeric",
                "size": "45"
            },
            {
                "field": "2",
                "description": "Payment Reference Number",
                "format": "Alphanumeric",
                "size": "45"
            },
            {
                "field": "3",
                "description": "Amount",
                "format": "Numeric",
                "size": "5"
            },
            {
                "field": "4",
                "description": "3-digit currency code",
                "format": "Alphabetic",
                "size": "3"
            }
        ]
    }
}

{
    "timestamp": "2024-10-25 06:15:22 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/biller/{jwtString}/update"
}

{
    "timestamp": "2024-10-25T06:25:22.045+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/biller/{jwtString}/update"
}