COMING SOON

List Merchants for a BIN

Retrieve a list of merchants for a card Bank Identification Number (BIN). The BIN is the first 4–6 digits of the card number and represents the financial institution for the card. You can filter the results by the Card Program ID, the merchant category and subcategory, and the merchant address.

To retrieve a list of merchants, you will need:

Card BIN

Endpoint

GET /v1/card-bins/{binNumber}/merchants

Authorization Header

Authorization: Bearer <access_token>

Path Parameters

binNumber REQUIRED

string

Card Bank Identification Number (BIN).

Query Parameters

cardProgramID

string

This filter will return merchants belonging to a specific Card Program ID.

merchantCategory

string

This filter will return merchants belonging to a specific merchant category.

merchantSubCategory

string

This filter will return merchants belonging to a specific merchant subcategory.

merchantAddress1

string

Merchant’s address line 1. This filter will return merchants with this address.

merchantAddress2

string

Merchant’s address line 2. This filter will return merchants with this address.

merchantCity

string

Merchant’s city. This filter will return merchants with this address.

merchantStateCode

string

Merchant’s state, province, or territory. Must be an ISO 3166-2 uppercase alpha 2-character or 3-character country subdivision code. For example, Missouri is MO. This filter will return merchants with this address.

merchantPostalCode

string

Merchant’s postal code. This filter will return merchants with this address.

merchantCountry

string

Merchant’s country. This filter will return merchants with this address.

Request Body

None

Returns

Returns an array of Merchant objects.

SAMPLE RESPONSE

				
					[
  {
    "merchantId": "1234567890",
    "merchantName": "XYZ Corporation",
    "merchantAddress": {
      "type": "WORKPLACE",
      "addressLine1": "1 Main St",
      "addressLine2": "Suite 201",
      "addressLine3": "Side door",
      "addressLine4": "",
      "addressLine5": "",
      "cityName": "Greenville",
      "stateCode": "MO",
      "countryCode": "USA",
      "zipCode": "63944"
    },
    "merchantPhone": "555-555-5555",
    "merchantFax": "555-555-1234",
    "merchantLogoUrl": "www.xyz.com/logo",
    "merchantDescription": "Hardware store",
    "merchantReviews": {
      "google": "www.google.com/xyz-corporation",
      "yelp": "www.yelp.com/xyz-corporation"
    },
    "merchantKeywords": [
      "hardware",
      "building supplies"
    ]
  },
  {...},
  {...}
]