Get Biller Requirements

An endpoint to get specific biller requirements.

To get biller requirements, send the following request header parameter via GET.

GET/biller/{jwtString}?passThrough=false

Biller Requirements

Request Samples

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

200 Successful Response

401 Erroneous Response

405 Erroneous Response

Response Samples

Billers Requirements ResponseBillers Requirements 401 Erroneous ResponseBillers Requirements 405 Erroneous Response

{
  "timestamp": "2024-10-23 02:35:04.420 +0000",
  "status": 200,
  "message": "OK",
  "path": "/biller/{jwtString}",
  "data": {
    "fields": [
      {
        "field": "{numeric}",
        "description": "{description}",
        "format": "{formatDescription}",
        "size": "{size}"
      }
    ],
    "notes": [
      {
        "note": "{numeric}",
        "description": "{description}",
        "value": "{numeric}"
      }
    ]
  }
}

{
  "timestamp": "2024-10-23 02:51:12 +0000",
  "status": 401,
  "error": "Unauthorized",
  "path": "/biller/{jwtString}"
}

{
  "timestamp": "2024-10-23 02:51:36.708 +0000",
  "status": 405,
  "error": "Method Not Allowed",
  "message": "Invalid Biller Code",
  "path": "/biller/{jwtString}"
}