Skip to content

Shift4 Payment API (1.7.43)

Overview
URL

https://www.shift4.com/contact-us/

Languages
Servers
Host Direct Test URL

https://api.shift4test.com/api/rest/v1/

Host Direct Production URL

https://api.shift4api.net/api/rest/v1/

Credentials

Operations

Transactions

Operations

Tokens

Operations

Merchants

Operations

Gift Cards

Operations

Cards

Operations

Verify Card with Processor

Request

This function is used to request card validation by going online to verify the card information with the processor. If Address Verification System (AVS) and/or Card Security Code (CSC) data are sent in the request, that information will also be validated.

To process an Account Name Inquiry request the USEANI API Option and customer.lastName must be sent in the request. customer.firstName and customer.middleName are optional. Account Name Inquiry requests are currently limited to Visa cards.

Integration Methods:

  • Host Direct
  • Locally Installed UTG

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

See the JSON Body Schemas for more details on the various JSON body formats.

Security
AccessToken
Headers
InterfaceVersionstring<= 11 charactersrequired

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: 2.1
InterfaceNamestring<= 25 charactersrequired

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: ForwardPOS
CompanyNamestring<= 26 charactersrequired

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: PAWS
AccessTokenstring(uuid)<= 52 charactersrequired

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
Bodyapplication/jsonrequired
One of:
dateTimestring(ISO 8601)required

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

Example: "2021-04-15T09:18:23.283-07:00"
deviceobjectrequired
Example: {"terminalId":"1742"}
device.​terminalIdstring<= 32 charactersrequired

To prompt a specific UTG-controlled PIN pad in a request, the API Terminal ID configured in UTG TuneUp must be specified in this field.

Example: "1742"
device.​promptPostalCodestring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for a ZIP/Postal Code.
NDo not force the PIN pad to prompt the consumer for a ZIP/Postal Code.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
device.​promptCardSecurityCodestring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for a CSC.
NDo not force the PIN pad to prompt the consumer for a CSC.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
device.​promptStreetNumberstring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for the street number of their billing address.
NDo not force the PIN pad to prompt the consumer for the street number of their billing address.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
transactionobject
customerobject
currencyCodestring(ISO 4217 3 Character Alphabetic Code)

Transaction currency code. See the Currency Codes section for details.

Note: This is currently supported when processing for a merchant outside of the US and Canada. If processing for a US or Canadian merchant then this field will be ignored and the transaction will process in the merchant's configured currency.

apiOptionsArray of stringswrite-only

API Options modify the request being made. See the API Options section for more information.

application/json
{
  "dateTime": "2021-04-15T09:18:23.283-07:00",
  "device": {
    "terminalId": "1742"
  }
}

Responses

Request was processed

Bodyapplication/json
resultArray of objects
Response
application/json
{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "customer": {
        "addressLine1": "65 Easy St",
        "firstName": "John",
        "middleName": "Andrew",
        "lastName": "Smith",
        "postalCode": "65144",
        "emailAddress": "john.smith@email.com",
        "ipAddress": "63.57.84.101"
      },
      "card": {
        "expirationDate": 1230,
        "number": "XXXXXXXXXXXX1119",
        "type": "VS",
        "securityCode": { … },
        "token": { … }
      },
      "device": {
        "terminalId": "1742"
      },
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "transaction": {
        "authorizationCode": "198399",
        "responseCode": "A",
        "avs": { … },
        "cardOnFile": { … }
      },
      "server": {
        "name": "TM01CE"
      },
      "accountNameInquiry": {
        "aniResponseCode": "E"
      }
    }
  ]
}

Identify Card Type

Request

This function is used to request and return the card type.

Integration Methods:

  • Host Direct
  • Locally Installed UTG

See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

See the JSON Body Schemas for more details on the various JSON body formats.

Security
AccessToken
Headers
InterfaceVersionstring<= 11 charactersrequired

Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: 2.1
InterfaceNamestring<= 25 charactersrequired

Refers to the name of the program or application that is sending requests to Shift4. This should be the name of the program that you purchased or created. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: ForwardPOS
CompanyNamestring<= 26 charactersrequired

Refers to the vendor or partner that designed and certified the interface. The information you use in this field should match what Shift4 has on file or what was agreed upon in your Integration Plan. The following special characters are not allowed: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Example: PAWS
AccessTokenstring(uuid)<= 52 charactersrequired

A security credential used to authenticate API requests and all i4Go® authorizeClient/preauthorizeClient requests. An Access Token is the alias for the merchant account and interface being used. The Access Token is required in all requests except an Access Token Exchange request, which generates an Access Token using an authToken and clientGuid.

Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
Bodyapplication/jsonrequired
One of:
dateTimestring(ISO 8601)required

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

Example: "2021-04-15T09:18:23.283-07:00"
deviceobjectrequired
Example: {"terminalId":"1742"}
device.​terminalIdstring<= 32 charactersrequired

To prompt a specific UTG-controlled PIN pad in a request, the API Terminal ID configured in UTG TuneUp must be specified in this field.

Example: "1742"
device.​promptPostalCodestring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for a ZIP/Postal Code.
NDo not force the PIN pad to prompt the consumer for a ZIP/Postal Code.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
device.​promptCardSecurityCodestring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for a CSC.
NDo not force the PIN pad to prompt the consumer for a CSC.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
device.​promptStreetNumberstring= 1 characters

When using a UTG-controlled PIN pad:

ValueDescription
YForce the PIN pad to prompt the consumer for the street number of their billing address.
NDo not force the PIN pad to prompt the consumer for the street number of their billing address.

Note: Use only when you want to override MCE (Manual Card Entry) settings in UTG.

Enum"Y""N"
application/json
{
  "dateTime": "2021-04-15T09:18:23.283-07:00",
  "device": {
    "terminalId": "1742"
  }
}

Responses

Request was processed

Bodyapplication/json
resultArray of objects
Response
application/json
{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "card": {
        "bin": "541333",
        "dccCapable": "Y",
        "debitCapable": "Y",
        "levelResult": "1P",
        "type": "VS"
      },
      "device": {
        "terminalId": "1742"
      },
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}

Devices

Operations

Reports

Operations

Batches

Operations

QR Payments

Operations

Mode

Operations

Risk

Operations

PayPal

Operations

3D Secure

Operations

OCT

Operations

ACH

OperationsWebhooks

Updater

Operations

DCC

Operations

Rules

Operations