RocketKOR

COMING SOON

Merchant Detail Object

The Merchant Detail object represents detailed information for a merchant. A merchant is a vendor that a Customer may conduct transactions with using an issued card.

Attributes

merchantId  

string, max length: 30

ID of the merchant.

merchantName

string, min length: 1, max length: 40

Name of the merchant.

merchantAddress

object

Merchant’s addresses. The merchant may have multiple addresses, such as a billing address, shipping address, and mailing address.

type  

string enum, values: WORKPLACE, RESIDENTIAL, MAILING, BILLING, SHIPPING, PHYSICAL, OTHER

Type of address.

addressLine1  

string, min length: 1, max length: 50

Address line 1.

addressLine2

string, min length: 1, max length: 50

Address line 2.

addressLine3

string, min length: 1, max length: 50

Address line 3.

addressLine4

string, min length: 1, max length: 50

Address line 4.

addressLine5

string, min length: 1, max length: 50

Address line 5.

cityName

string, min length: 1, max length: 25

City.

stateCode

string, min length: 2, max length: 3

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.

countryCode

string, min length: 3, max length: 3

Country code. Must be an ISO 3166-1 uppercase alpha 3-character country code. For example, the United States is USA and Canada is CAN.

zipCode

string, min length: 1, max length: 10

Zip code or postal code.

merchantPhone

string, max length: 40

Merchant’s primary phone number.

merchantFax

string, max length: 15

Merchant’s fax number.

merchantLogoUrl

string

Web address of the merchant’s logo.

merchantDescription

string, max length: 255

Detailed description of the merchant.

merchantReviews

hash map

Links to reviews for the merchant in various sites (Google, Yelp, etc.).

merchantKeywords

string, max length: 20

List of keywords used with the merchant.

merchantCategory

string

Merchant category.

merchantSubCategory

string

Merchant subcategory.

merchantLongitude

number

Merchant longitude.

merchantLatitude

number

Merchant latitude.

webUrl

string

Web address of the merchant’s website.

merchandiseDescription

string

Short description of the merchant’s merchandise.

merchandisePriceRange

string

Short description of the price range for the merchant’s merchandise.

merchantWorkSchedule

array

Opening and closing times for the merchant’s business.

{day}

object

Opening and closing hours for a day of the week. The {day} object name will be the day (Monday, Tuesday, and so on).

open

string (time)

Opening time.

close

string (time)

Closing time.

Merchant Detail Object

				
					{
  "merchantId": "1234567890",
  "merchantName": "XYZ Corporation",
  "merchantAddress": {
    "type": "WORKPLACE",
    "addressLine1": "1 Main St",
    "addressLine2": "Suite 201",
    "addressLine3": "",
    "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"
  ],
  "merchantCategory": "string",
  "merchantSubCategory": "string",
  "merchantLongitude": 0,
  "merchantLatitude": 0,
  "webUrl": "www.xyz-corporation.com",
  "merchandiseDescription": "Hardware and building supplies",
  "merchandisePriceRange": "under 2000",
  "merchantWorkSchedule": {
    "Monday": {
      "open": "9:00",
      "close": "17:00"
    },
    "Tuesday": {
      "open": "9:00",
      "close": "17:00"
    },
    "Wednesday": {
      "open": "9:00",
      "close": "17:00"
    },
    "Thursday": {
      "open": "9:00",
      "close": "17:00"
    },
    "Friday": {
      "open": "9:00",
      "close": "17:00"
    },
    "Saturday": {
      "open": "9:00",
      "close": "21:00"
    },
    "Sunday": {
      "open": "9:00",
      "close": "15:00"
    }
  }
}