Sign in

v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB
Credentials

Access Token Exchange

This function is used to request exchanging a Client GUID and Auth Token for an Access Token.

Integration Methods:

  • Host Direct
  • Locally Installed UTG
  • Commerce Engine For On Premise
  • Commerce Engine For Cloud

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

post/credentials/accesstoken

Headers

InterfaceVersionstring required
Example:2.1

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

InterfaceNamestring required
Example:ForwardPOS

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: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

CompanyNamestring required
Example:PAWS

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: $ % : ^ - ~ ` < > , ? “ ” ‘ ’ { } [ ] \ + =

Request body

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 request

{
  "dateTime": "2024-05-21T09:18:23.283-07:00",
  "credential": {
    "accessToken": "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D",
    "authToken": "3504489F-A774-88E0-80114FBBC925E207",
    "clientGuid": "A3B18F21-AD17-8416-0626C4C9F1CA86A7",
    "apiSerialNumber": "266",
    "apiPassword": "9YCR23G7%BY#9+"
  }
}

Response

AccessToken request was processed

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "credential": {
        "accessToken": "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D"
      },
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}