v1

latestOpenAPI 3.0.12026-07-24256962.9 KB
Billers

Search Billers

get/billers

Query parameters

namestring string required

The Business Name

postalCodestring string

The Business PostalCode

groupIdstring uuid

The Business Group Id

Headers

Trace-Idstring

A valid UUID (V4) for tracing requests. Will be returned as a header. If not present or invalid, a generated UUID will be returned.

End-User-Agentstring

A string representing the User Agent of the end user. Recommended for compliance. Required only when the request is not coming from the end user's browser.

End-User-Device-Idstring

A unique identifier for the end user's device. Recommended for compliance.

End-User-Ipstring

The IP address of the end user. Recommended for compliance.

Response

A list of Billers

Example response

{
  "data": [
    {
      "groupId": "478d120a-df4a-5ae7-a102-600a78d0444f",
      "billers": [
        {
          "id": "c577fd87-2294-5455-9d8e-0fa472c23ee7",
          "businessName": "Verizon",
          "groupId": "478d120a-df4a-5ae7-a102-600a78d0444f",
          "businessAddress": {
            "line1": "19439 Stevens Creek Blvd",
            "city": "Cupertino",
            "state": "CA",
            "postalCode": "95014",
            "country": "US"
          },
          "categoryId": "d7a2beba-0c2c-42de-9690-26f00ba08339"
        }
      ]
    }
  ]
}
All 25 operations