---
title: "Merchant Information"
method: GET
path: "/merchants/merchant"
tags: ["Merchants"]
---

# Merchant Information

`GET /merchants/merchant`

Used to request information about the merchant.

*Note: The GET request does not support a request body. Sending an empty request body may result in an error.*

**Integration Methods:**
- Host Direct
- Locally Installed UTG
- Commerce Engine For On Premise
- Commerce Engine For Cloud

See the [Integration Methods](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required
- `ApiOptions` string

## Response `200`

Request was processed

- union
  - object
    - `result` object[]
      - `dateTime` string, ISO 8601 — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
      - `merchant` object
        - `addressLine1` string — First line in the merchant’s business address as configured with Shift4.
        - `addressLine2` string — Second line in the merchant’s business address as configured with Shift4.
        - `city` string — City of the merchant’s business address as configured with Shift4.
        - `dayEndingTime` string — The time the merchant’s business day ends as configured with Shift4. **Note: This is only applicable for merchants based in the USA. If the merchant is not based in the USA, this field will not be returned.**
        - `defaultCurrency` string, ISO 4217 3 Character Alphabetic Code — Merchant's default currency. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
        - `supportedCurrencies` string, ISO 4217 3 Character Alphabetic Code — Comma separated list of currnecies the merchant supports. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
        - `industry` 'A' | 'F' | 'H' | 'M' | 'R' | 'P' — Classifies the merchant type for a merchant’s account with Shift4. Value|Description -----|----------- A | Auto Rental F | Food & Beferage (F&B) H | Hotel M | Mail order/Telephone Order (MOTO) or E-Commerce R | Retail P | Passenger Transport
        - `mid` number — The merchant ID associated with the merchant account.
        - `name` string — The merchant’s business name as configured with Shift4.
        - `region` string — Region (State) of the merchant’s business address as configured with Shift4.
        - `phone` string — The merchant’s business telephone number as configured with Shift4.
        - `postalCode` string — ZIP/Postal Code of the merchant’s business address as configured with Shift4.
        - `serialNumber` string — The serial number of the merchant's account with Shift4.
        - `cardTypes` MerchantCardTypes[] — Array of Merchant Card Types
          - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP | Alipay BC | Backed Card CI | Citgo DB | Debit card GC | Gift Card JC | JCB MC | Mastercard NS | Discover/JCB/Novus PL | Private Label SC | Sears Canada VS | Visa WP | WeChat Pay YC | IT’S YOUR CARD
          - `voiceCenter` VoiceCenter
            - `accountNumber` string — The merchant’s account number as configured with Shift4. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request because the clerk is required to provide it when attempting to obtain a voice authorization code. This information must be displayed to the clerk.
            - `phoneNumber` string — The phone number a clerk must call to obtain a voice authorization code. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request. This information must be displayed to the clerk.
        - `dcc` MerchantDCCObject
          - `enabled` 'Y' | 'N' — Determines whether the merchant has dynamic currency conversion enabled. Value|Description -----|----------- Y | DCC is enabled N | DCC is not enabled
          - `secondaryLookupDisclaimer` 'Y' | 'N' — Determines whether the merchant must perform a secondary rate lookup before capture and if a secondary disclaimer is required. Value|Description -----|----------- Y | Yes - Secondary rate-lookup on capture, accept/decline screen, and larger disclaimer on printed receipt required. N | No - Secondary rate-lookup, accept/decline screen, and larger disclaimer NOT required
          - `cardTypes` object[] — Array of DCC supported card types
            - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP | Alipay BC | Backed Card CI | Citgo DB | Debit card GC | Gift Card JC | JCB MC | Mastercard NS | Discover/JCB/Novus PL | Private Label SC | Sears Canada VS | Visa WP | WeChat Pay YC | IT’S YOUR CARD
            - `processor` string — The processor configured for the card type.
        - `gtv` MerchantGTVObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant is configured to support Tokenization using Shift4’s Global Token Vault (GTV) solution. Value|Description -----|----------- Y | GTV is enabled N | GTV is not enabled
        - `surcharge` MerchantSurchargeObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant is configured to support Surcharging. Value|Description -----|----------- Y | Surcharging is enabled N | Surcharging is not enabled
        - `autoClose` MerchantAutoCloseObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant has Auto Close enabled for transaction batches. Value|Description -----|----------- Y | Auto Close is enabled N | Auto Close is not enabled
      - `server` Server
        - `name` string — The name of the server that processed the request.
  - object
    - `result` object[]
      - `dateTime` string, ISO 8601 — The date and time in ISO 8601 format including the timezone offset (yyyy-mm-ddThh:mm:ss.nnn+hh:mm). Must be sent as the local date/time of the merchant. For example, a request processed at a merchant in the Pacific time zone at 9:18am on April 15th 2021 would be sent as 2021-04-15T09:18:23.283-07:00
      - `merchant` object
        - `addressLine1` string — First line in the merchant’s business address as configured with Shift4.
        - `addressLine2` string — Second line in the merchant’s business address as configured with Shift4.
        - `city` string — City of the merchant’s business address as configured with Shift4.
        - `dayEndingTime` string — The time the merchant’s business day ends as configured with Shift4. **Note: This is only applicable for merchants based in the USA. If the merchant is not based in the USA, this field will not be returned.**
        - `defaultCurrency` string, ISO 4217 3 Character Alphabetic Code — Merchant's default currency. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
        - `supportedCurrencies` string, ISO 4217 3 Character Alphabetic Code — Comma separated list of currnecies the merchant supports. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
        - `industry` 'A' | 'F' | 'H' | 'M' | 'R' | 'P' — Classifies the merchant type for a merchant’s account with Shift4. Value|Description -----|----------- A | Auto Rental F | Food & Beferage (F&B) H | Hotel M | Mail order/Telephone Order (MOTO) or E-Commerce R | Retail P | Passenger Transport
        - `mid` number — The merchant ID associated with the merchant account.
        - `name` string — The merchant’s business name as configured with Shift4.
        - `region` string — Region (State) of the merchant’s business address as configured with Shift4.
        - `phone` string — The merchant’s business telephone number as configured with Shift4.
        - `postalCode` string — ZIP/Postal Code of the merchant’s business address as configured with Shift4.
        - `serialNumber` string — The serial number of the merchant's account with Shift4.
        - `cardTypes` MerchantCardTypesReturnProcessors[] — Array of Merchant Card Types
          - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP | Alipay BC | Backed Card CI | Citgo DB | Debit card GC | Gift Card JC | JCB MC | Mastercard NS | Discover/JCB/Novus PL | Private Label SC | Sears Canada VS | Visa WP | WeChat Pay YC | IT’S YOUR CARD
          - `processor` string — The processor configured for the card type.
          - `ranges` MerchantCardTypesRangesObject[] — Array of card ranges
            - `lower` string — Lower limit for the card range
            - `upper` string — Upper limit for the card range
            - `lengths` string — Comma separated list of possible lengths for the card range.
            - `lunhCheck` boolean — Specifies whether or not the card range will pass the luhn check.
          - `voiceCenter` VoiceCenter
            - `accountNumber` string — The merchant’s account number as configured with Shift4. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request because the clerk is required to provide it when attempting to obtain a voice authorization code. This information must be displayed to the clerk.
            - `phoneNumber` string — The phone number a clerk must call to obtain a voice authorization code. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request. This information must be displayed to the clerk.
        - `dcc` MerchantDCCObject
          - `enabled` 'Y' | 'N' — Determines whether the merchant has dynamic currency conversion enabled. Value|Description -----|----------- Y | DCC is enabled N | DCC is not enabled
          - `secondaryLookupDisclaimer` 'Y' | 'N' — Determines whether the merchant must perform a secondary rate lookup before capture and if a secondary disclaimer is required. Value|Description -----|----------- Y | Yes - Secondary rate-lookup on capture, accept/decline screen, and larger disclaimer on printed receipt required. N | No - Secondary rate-lookup, accept/decline screen, and larger disclaimer NOT required
          - `cardTypes` object[] — Array of DCC supported card types
            - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP | Alipay BC | Backed Card CI | Citgo DB | Debit card GC | Gift Card JC | JCB MC | Mastercard NS | Discover/JCB/Novus PL | Private Label SC | Sears Canada VS | Visa WP | WeChat Pay YC | IT’S YOUR CARD
            - `processor` string — The processor configured for the card type.
        - `gtv` MerchantGTVObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant is configured to support Tokenization using Shift4’s Global Token Vault (GTV) solution. Value|Description -----|----------- Y | GTV is enabled N | GTV is not enabled
        - `surcharge` MerchantSurchargeObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant is configured to support Surcharging. Value|Description -----|----------- Y | Surcharging is enabled N | Surcharging is not enabled
        - `autoClose` MerchantAutoCloseObject
          - `enabled` 'Y' | 'N' — Indicates whether merchant has Auto Close enabled for transaction batches. Value|Description -----|----------- Y | Auto Close is enabled N | Auto Close is not enabled
      - `server` Server
        - `name` string — The name of the server that processed the request.

## Other responses

- `400` — Error
- `504` — Timeout

---

[API](https://skmtc.dev/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.dev/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/revisions/2f85c87cc9e5/schema)