Sign in

v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB
Tokens

Universal Token

This function requests that the existing universal token for a card be returned.

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 and URLs Section sections of the Development Quick Start guide for details regarding each processing option.

get/tokens/universaltoken

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

AccessTokenstring uuid required
Example:EA79FB05-3AA7-4500-AF9A-73F986FF2C1D

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.

CardNumberstring
Example:4321000000001119

The payment card number. This field will always be masked when returned in a response.

P2PEDatastring

The full output of a P2PE keypad/magnetic swipe reader (MSR).

P2PEFormat'01' | '02' | '03' | '04' | '05'

Classifies the type of payment device being used for P2PE.

ValueDescription
01IDTech Enhanced Encryption format, USB KB mode
02IDTech Enhanced Encryption format, USB HID mode
03Ingenico format
04VeriFone format
05Shift4 TDES DUKPT format
P2PEKsnstring

Conditional: Required when p2pe.format == "05"

The key serial number which was used to encrypt the P2PE data.

SerialNumberstring
Example:266

In requests that require the use of a shared card token that is held by another merchant account, such as in TokenStore or TokenShare®, this field is used to specify the serial number for the account where the card token is stored.

Tokenstring
Example:8048471746471119

This field is used to specify the token for the payment method.

TrackDatastring

Conditional: Send in the initial authorization/sale request when processing a swiped MSR transaction. This field is not specified when using True P2PE® (point-to-point encryption) or a UTG-controlled PIN pad.

Card swipe data exactly as read by an MSR.

Response

Request was processed

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "server": {
        "name": "TM01CE"
      },
      "universalToken": {
        "value": "97032276-5944-00000001-16985FD179D"
      }
    }
  ]
}