AccessToken request was processed
Shift4 Payment API (1.7.43)
Overview
Languages
Servers
Host Direct Test URL
https://api.shift4test.com/api/rest/v1/
Host Direct Production URL
https://api.shift4api.net/api/rest/v1/
Request
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.
Headers
Bodyapplication/jsonrequiredRefers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed: $ % : ^ - ~ < > , ? “ ” ‘ ’ { } [ ] \ + =
Example: 2.1
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
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
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
A unique encrypted identifier that refers to a specific merchant account. It is required when making an Access Token Exchange request. For detailed information about the AuthToken, please see Authentication
The Client GUID is a unique identifier that is used to identify an interface across all of the merchant accounts that use it. The same Client GUID can be used for all versions of the same interface. If a completely new interface is certified, then you will receive a new Client GUID, which must be hard coded into the application and must not be a configurable field. The Client GUID is required when making an Access Token Exchange. For detailed information about the Client GUID, please see Authentication.
Requirement: The Client GUID supplied by your API Analyst must be hard coded into your application because it will permanently identify your interface across all merchant accounts.
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/credentials/accesstoken
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/credentials/accesstoken
- Locally Installed UTG URL
https://192.168.1.10:277/api/rest/v1/credentials/accesstoken
- Commerce Engine For On Premise URL
https://192.168.1.20:8085/api/rest/v1/credentials/accesstoken
- Commerce Engine For Cloud Test URL
https://api.shift4test.com/api/rest/v1/credentials/accesstoken
- Commerce Engine For Cloud Production URL
https://api.shift4api.net/api/rest/v1/credentials/accesstoken
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "credential": { "authToken": "3504489F-A774-88E0-80114FBBC925E207", "clientGuid": "A3B18F21-AD17-8416-0626C4C9F1CA86A7" } }
Response
application/json
{ "result": [ { "dateTime": "2024-05-21T09:18:23.283-07:00", "credential": { "accessToken": "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D" }, "server": { "name": "TM01CE" } } ] }