View Billers

View Billers

GET https://api.synapsefi.com/v3.1/billers

This endpoint allows you to view biller info for RPPS nodes.

Query Parameters

Name	Type	Description
filter	string	MongoDB filter to enable search by biller_name type of functionality.
per_page	integer	Maximum documents to return per page. Default and max allowed is 20.
page	integer	Page number of the paginated request. Default is 1.

Headers

Name	Type	Description
Content-Type	string	This value should be application/json

200 Billers found.

{
  "billers": [
    {
      "_id": "5ec329342aadcf1f40b661ae",
      "biller_id": "8543660183",
      "biller_name": "AAA INSURANCE",
      "biller_type": "Test"
    }
    ...
  ],
  "page_count": 2,
  "error_code": "0",
  "http_code": "200",
  "page": 1
}

Biller Name Options

The following values are available for biller_name search option.

Biller Name Options

'Airline', 'Auto Finance', 'Bank Card', 'Cable', 'Church', 'Club / Membership', 'College Savings Plan', 'DSL - ISP', 'Debt Management', 'Electric / Gas / Power / Water', 'Financial Services', 'Gas / Oil Card', 'Healthcare Services', 'Homeowners Association', 'Insurance', 'Mortgage', 'Municipality', 'Other', 'Personal Banking (checking, savings, etc.)', 'Phone', 'Rental Properties', 'Retail', 'Sanitation', 'Satellite Radio', 'Satellite TV', 'School / Car / Bank Loan & Finance', 'Schools & Educational Services', 'Security Systems / Monitoring Services', 'Subscription', 'Taxes', 'Tuition', 'Wireless - Phone'

Example Request

HTTP

GET /v3.1/billers?filter={"biller_name":"INSURANCE"} HTTP/1.1
Host: uat-api.synapsefi.com
Content-Type: application/json

cURL

curl --location -g --request GET 'https://uat-api.synapsefi.com/v3.1/billers?filter={%22biller_name%22:%22INSURANCE%22}' \
--header 'Content-Type: application/json'

Python

//

JavaScript

//

Ruby

//

PHP

//

Go

//