v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB

Transactions

Invoice Information

Used to request the status (e.g., approved, declined, error, referral, etc.) for a specific invoice; it is primarily used after a timeout or error has occurred. Voided or batched and settled invoices will return an “Invoice Not Found” error. For more information, see the Timeouts and Communication Failures section.

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/transactions/invoice

Headers

Invoicestring required

10-digit invoice number assigned by the interface to identify a transaction. An invoice number serves as a unique key that identifies a transaction within a batch in Shift4's Gateway.

Note: For US and Canadian processing: Although the invoice number is sent as a JSON string it is a numeric value. No alpha characters are allowed.

For processing outside of the US and Canada alpha characters are allowed.

Example:0510093358

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.

ApiOptionsstring

API Options modify the request being made. Multiple API Options can be sent in a comma separated list with no spaces. See the API Options section for more information.

ReceiptColumnsinteger

Example:40

Send this field if you want Shift4 to format the receipt text instead of returning individual fields. The value sent will correlate to the column width of the formatted receipt that we return. (This also allows the receipt text to wrap to fit the paper size of the printed receipt.) See the Printing Receipts section of this document for more information on formatted receipts.

Tokenstring

Example:8048471746471119

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

Response

Request was processed

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "amount": {
        "total": 160,
        "tax": 15,
        "taxIndicator": "Y",
        "cashback": 20,
        "iiasAmounts": [
          {
            "type": "4S",
            "amount": 75
          },
          {
            "type": "4W",
            "amount": 25
          }
        ],
        "surcharge": 5,
        "tip": 20,
        "checkTotal": 200
      },
      "card": {
        "entryMode": "M",
        "expirationDate": 1230,
        "levelResult": "2C",
        "number": "XXXXXXXXXXXX1119",
        "present": "Y",
        "type": "VS",
        "balance": {
          "amount": 24.33
        },
        "securityCode": {
          "result": "M",
          "valid": "Y"
        },
        "token": {
          "value": "8048471746471119"
        },
        "debitType": "girocard"
      },
      "customer": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "clerk": {
        "numericId": 1576
      },
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "transaction": {
        "authorizationCode": "198399",
        "authSource": "E",
        "invoice": "0510093358",
        "responseCode": "A",
        "saleFlag": "S"
      },
      "receipt": [
        {
          "key": "ApplicationIdentifier",
          "printName": "AID",
          "printValue": "A0000000031010"
        },
        {
          "key": "TerminalVerificationResults",
          "printName": "TVR",
          "printValue": "8000"
        },
        {
          "key": "IssuerApplicationData",
          "printName": "IAD",
          "printValue": "06010A03A40002"
        },
        {
          "key": "TransactionStatusIndicator",
          "printName": "TSI",
          "printValue": "E800"
        },
        {
          "key": "AuthorizationResponseCode",
          "printName": "ARC",
          "printValue": "00"
        },
        {
          "key": "TransactionCurrencyCode",
          "printValue": "USD$"
        },
        {
          "key": "ApplicationLabel",
          "printValue": "CREDITO DE VISA"
        }
      ],
      "server": {
        "name": "TM01CE"
      }
    }
  ]
}