Get Billers

An endpoint to get all available billers.

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

Get BillersGet Detailed BillersGet Categorized Billers

GET/biller?detailed=false&expirable=true&passThrough=false

GET/biller?detailed=true&expirable=true&passThrough=false

GET/biller?detailed=false&expirable=true&category={categoryName}&passThrough=false

Billers

Request Samples

curlcurl detailedcurl categorized

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

curl 
    -L -X GET 'http://test-api.billeroo.com/biller?detailed=true&expirable=true&passThrough=false' \
    -H 'Authorization: {integratorToken}'

curl
    -L -X GET 'http://test-api.billeroo.com/biller?detailed=true&expirable=true&category={categoryName}&passThrough=false' \
    -H 'Authorization: {integratorToken}'

200 Successful Response

200 Successful Response for Detailed Biller

401 Erroneous Response

Response Samples

Billers ResponseDetailed Billers ResponseCategorized Billers ResponseBillers 401 Erroneous Response

{
  "timestamp": "2024-10-22 06:47:31.894 +0000",
  "status": 200,
  "message": "OK",
  "path": "/biller",
  "data": [
    {
      "code": "{jwtString}",
      "categoryName": "{categoryName}",
      "value": "{billerName}",
      "imageUrl": "{ImageUrl}"
    }
  ]
}

{
  "timestamp": "2024-10-22 06:22:48.122 +0000",
  "status": 200,
  "message": "OK",
  "path": "/biller",
  "data": [
    {
      "code": "{jwtString}",
      "value": "{billerName}",
      "fields": [
          {
            "field": "{numeric}",
            "description": "{description}",
            "format": "{formatDescription}",
            "size": "{size}"
          }
      ],
      "notes": [
          {
            "note": "{numeric}",
            "description": "{description}",
            "value": "{numeric}"
          }
      ],
      "categoryName": "{categoryName}",
      "imageUrl": "{imageUrl}"
    }
  ]
}

{
  "timestamp": "2024-10-22 06:50:10.159 +0000",
  "status": 200,
  "message": "OK",
  "path": "/biller",
  "data": [
    {
      "code": "{jwtString}",
      "categoryName": "{categoryName}",
      "value": "{billerName}",
      "imageUrl": "{ImageUrl}"
    },
    {
      "code": "{jwtString}",
      "categoryName": "{categoryName}",
      "value": "{billerName}",
      "imageUrl": "{ImageUrl}"
    }
  ]
}

{
  "timestamp": "2024-10-22 06:54:13 +0000",
  "status": 401,
  "error": "Unauthorized",
  "path": "/biller"
}