How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Shift4 Merchants API

The Merchants API from Shift4 — 1 operation(s) for merchants.

Shift4 Merchants API is one of 21 APIs that Shift4 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Merchants. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 1 operation across 1 path, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.7.57.

Requests are made against 2 base URLs: https://api.shift4test.com/api/rest/v1, https://api.shift4api.net/api/rest/v1.

1 operations 1 paths 49 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.7.57
Base URL
https://api.shift4api.net/api/rest/v1
Authentication
API Key, HTTP Hmac-Sha256
Resource Areas
1

Authentication & Security 2

Shift4 Merchants API declares 2 security schemes for authenticating requests. An API key is passed in the header as AccessToken (AccessToken). It uses HTTP hmac-sha256 authentication (HMAC-SHA256).

  • AccessToken — A security credential used to authenticate API requests and all [i4Go®](https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20re…
  • HMAC-SHA256 — Authentication using HMAC-256 signatures as the authorization scheme. Sent in the Authorization header in the following format: Authorization: HMAC-SHA256 Cred…

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Merchants 1
GET
/merchants/merchant
Merchant Information
merchantsmerchant 5 params → 200400504

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are Error (6 properties), MerchantCardTypesRangesObject (4 properties), MerchantCardTypesReturnProcessors (4 properties), MerchantDCCObject (3 properties). Each schema is shown below with its type and property counts.

MerchantDCCSecondaryLookupDisclaimer
string
Determines whether the merchant must perform a secondary rate lookup before capture and if a secondary disclaimer is required. Value|Description -----|--------…
MerchantSurchargeEnabled
string
Indicates whether merchant is configured to support Surcharging. Value|Description -----|----------- Y | Surcharging is enabled N | Surcharging is not enabled
MerchantIndustry
string
Classifies the merchant type for a merchant’s account with Shift4. Value|Description -----|----------- A | Auto Rental F | Food & Beferage (F&B) H | Hotel M |…
MerchantAutoCloseObject
object
1 property
MerchantDCCEnabled
string
Determines whether the merchant has dynamic currency conversion enabled. Value|Description -----|----------- Y | DCC is enabled N | DCC is not enabled
MerchantCardTypesRangesArray
array
Array of card ranges
MerchantCardTypesRangesObject
object
4 properties
MerchantCardTypeRangesUpper
string
Upper limit for the card range
MerchantMID
number
The merchant ID associated with the merchant account.
MerchantPhone
string
The merchant’s business telephone number as configured with Shift4.
MerchantCardTypesPhoneNumber
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…
Error
object
6 properties
MerchantDCCCardTypesArray
array
Array of DCC supported card types
MerchantDayEndingTime
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…
VoiceCenter
object
2 properties
MerchantCardTypeRangesLuhnCheck
boolean
Specifies whether or not the card range will pass the luhn check.
ServerName
string
The name of the server that processed the request.
MerchantName
string
The merchant’s business name as configured with Shift4.
CardTypeResp
string
An abbreviation used to specify the type of card that was used when processing a transaction. Value| Description -----|------------ AX | American Express AP |…
MerchantCardTypesReturnProcessors
object
4 properties
Server
object
1 property
MerchantAutoCloseEnabled
string
Indicates whether merchant has Auto Close enabled for transaction batches. Value|Description -----|----------- Y | Auto Close is enabled N | Auto Close is not…
ErrorSeverity
string
Severity level of the error. | Severity | Description | | -------- | ---------------------------------------------------------------- | | Info | Action not req…
DateTime
string
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 ex…
MerchantCardTypesReturnProcessorsArray
array
Array of Merchant Card Types
MerchantGTVObject
object
1 property
MerchantCardTypeRangesLower
string
Lower limit for the card range
ErrorLongText
string
Extended error message that is returned if an error condition exists.
MerchantCardTypes
object
2 properties
MerchantAddressLine1
string
First line in the merchant’s business address as configured with Shift4.
MerchantSerialNumber
string
The serial number of the merchant's account with Shift4.
MerchantSurchargeObject
object
1 property
MerchantCity
string
City of the merchant’s business address as configured with Shift4.
ErrorShortText
string
Abbreviated error message that is always returned if an error condition exists
MerchantSupportedCurrencies
string
Comma separated list of currnecies the merchant supports. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
LighthouseDataResponse
string
Base64 encoded JSON formatted data that will be returned from Lighthouse to be passed back to SkyTab. This data will contain variable information.
ErrorPrimaryCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.
MerchantPostalCode
string
ZIP/Postal Code of the merchant’s business address as configured with Shift4.
MerchantGTVEnabled
string
Indicates whether merchant is configured to support Tokenization using Shift4’s Global Token Vault (GTV) solution. Value|Description -----|----------- Y | GTV…
MerchantCardTypesArray
array
Array of Merchant Card Types
ErrorCode
integer
Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details. Note: Th…
MerchantDCCObject
object
3 properties
MerchantCardTypesAccountNumber
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/me…
MerchantAddressLine2
string
Second line in the merchant’s business address as configured with Shift4.
ErrorSecondaryCode
integer
This code supplements the code specified in the error.primaryCode field to provide additional information about the error that occurred.
MerchantCardTypeRangesLengths
string
Comma separated list of possible lengths for the card range.
MerchantCardTypeProcessor
string
The processor configured for the card type.
MerchantDefaultCurrency
string
Merchant's default currency. See the [Currency Codes](/guides/appendices/currency-codes) section for details.
MerchantRegion
string
Region (State) of the merchant’s business address as configured with Shift4.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

shift4-merchants-api-openapi.yml Raw ↑

Other APIs Shift4 publishes across the network.

Shift4 3D Secure API
Shift4 ACH API
Shift4 Batches API
Shift4 Cards API
Shift4 Checkout Sessions API
Shift4 Credentials API
Shift4 DCC API
Shift4 Devices API
Shift4 Gift Cards API
Shift4 Mode API
Shift4 OCT API
Shift4 Payment Links API
Where this information came from

This is an independent, third-party profile of Shift4 Merchants API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.