Generate Biller Reference Requirements

An endpoint to get the details of generate reference requirements.

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

GET/biller/{jwtString}/generate?customerReference={customerReference}&passThrough=false

Generate Biller Reference Requirements

Request Samples

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

200 Successful Response

401 Erroneous Response

404 and 405 Erroneous Response

Response Samples

Generate Biller Reference Requirements Response for (SSS)Generate Biller Reference Requirements Response (BRN)Generate Biller Reference Requirements 401 Erroneous ResponseGenerate Biller Reference Requirements 404 Erroneous ResponseGenerate Biller Reference Requirements 405 Erroneous Response

{
    "timestamp": "2024-10-24 06:08:02 +0000",
    "status": 200,
    "message": "OK",
    "path": "/biller/{jwtString}/generate",
    "data": {
        "fields": [
            {
                "field": "1",
                "description": "Member Type[1/2/4/5]",
                "format": "Numeric",
                "size": "1"
            },
            {
                "field": "2",
                "description": "SS Number",
                "format": "Numeric",
                "size": "10"
            },
            {
                "field": "3",
                "description": "Amount",
                "format": "Numeric",
                "size": "12,2"
            },
            {
                "field": "4",
                "description": "Voluntary Pension Booster Amount",
                "format": "Numeric",
                "size": "12,2"
            },
            {
                "field": "5",
                "description": "Applicable Start Month(MMYYYY)",
                "format": "Numeric",
                "size": "6"
            },
            {
                "field": "6",
                "description": "Applicable End Month(MMYYYY)",
                "format": "Numeric",
                "size": "6"
            },
            {
                "field": "7",
                "description": "Voluntary Pension Booster Flag",
                "format": "Numeric",
                "size": "1"
            }
        ],
        "notes": [
            {
                "note": "1",
                "description": "Member Type Codes",
                "value": "1 - SE, 2 - VM, 4 - NWS, 5 - OFW"
            },
            {
                "note": "2",
                "description": "Voluntary Pension Booster Flag Codes",
                "value": " 0 - Regular Contri No Voluntary Pension Booster, 1 - Regular Contri with Voluntary Pension Booster, 2 - Voluntary Pension Booster Only"
            }
        ]
    }
}

{
    "timestamp": "2024-10-25 05:39:44 +0000",
    "status": 200,
    "message": "OK",
    "path": "/biller/{jwtString}/generate",
    "data": {
        "fields": [
            {
                "field": "1",
                "description": "Any reference number identifier (mobile, card number, account number, Statement of Account Number)",
                "format": "Alphanumeric",
                "size": "45"
            },
            {
                "field": "2",
                "description": "BRN description (payment for ???)",
                "format": "Alphanumeric",
                "size": "255"
            },
            {
                "field": "3",
                "description": "Amount",
                "format": "Numeric",
                "size": "5"
            },
            {
                "field": "4",
                "description": "3-digit currency code",
                "format": "Alphabetic",
                "size": "3"
            },
            {
                "field": "5",
                "description": "Expirable (true or false)",
                "format": "Alphabetic",
                "size": "true/false"
            },
            {
                "field": "6",
                "description": "Expiration value (in minutes)",
                "format": "Numeric",
                "size": "7"
            },
            {
                "field": "7",
                "description": "Applicable Date (Start) / Billing coverage (Optional)",
                "format": "Date",
                "size": "3"
            },
            {
                "field": "8",
                "description": "Applicable Date (End) / Billing coverage (Optional)",
                "format": "Date",
                "size": "3"
            }
        ],
        "notes": [
            {
                "note": "1",
                "description": "currency",
                "value": "3-String ISO Currency Code. Alpha-3 Code"
            },
            {
                "note": "2",
                "description": "applicable date",
                "value": "Standard ISO 8601 format (yyyy-mm-dd)"
            }
        ]
    }
}

{
    "timestamp": "2024-10-24 07:41:48 +0000",
    "status": 401,
    "error": "Unauthorized",
    "path": "/biller/{jwtString}/generate"
}

{
    "timestamp": "2024-10-24T07:42:41.789+0000",
    "status": 404,
    "error": "Not Found",
    "message": "No message available",
    "path": "/biller/{jwtString}/generate"
}

{
    "timestamp": "2024-10-24 07:44:32.914 +0000",
    "status": 405,
    "error": "Method Not Allowed",
    "message": "Invalid Biller Code",
    "path": "/biller/{jwtString}/generate"
}