v1

latestOpenAPI 3.0.02026-07-2640301.0 MB

Bill Pay Endpoints

bill-pay/merchants

This endpoint is used to fetch bill pay merchants.

get/bill-pay/merchants

Query parameters

AccountIDstring required

Your account ID

Keystring required

API key for the account

Signaturestring required

Hashed signature for the request

SearchTextstring

Text to search for in merchant names.

Limitinteger

The maximum number of merchants to return. Default is 50.

Offsetinteger

The number of merchants to skip. Default is 0.

Response

Successboolean

ErrorMessagestring

Merchantsobject

PaginationMetaDataobject

Example response

{
  "Success": true,
  "Merchants": {
    "0": {
      "BillPayMerchantID": "169",
      "MerchantID": "340",
      "MerchantName": "ACCESS MOORE DECOR",
      "MerchantCategory": "",
      "PaymentAccountFormat": "",
      "CreditInstitution": "2",
      "CreditCategory": "5",
      "CanadianCreditorIdentificationNumber": "90109403"
    }
  }
}