Sign in

v1

latestOpenAPI 3.1.02026-08-06731,0781.4 MB
Gift Cards

Activate

This function requests that a new gift card be activated for use or that a new gift card be loaded with funds.

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.

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

post/giftcards/activate

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.

Request body

OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "dateTime": "2021-04-15T09:18:23.283-07:00",
  "amount": {
    "total": 25
  },
  "card": {
    "present": "Y"
  },
  "transaction": {
    "invoice": "192029"
  }
}

Response

Transaction was processed

Example response

{
  "result": [
    {
      "dateTime": "2024-05-21T09:18:23.283-07:00",
      "amount": {
        "total": 20
      },
      "card": {
        "number": "XXXXXXXXXXXX8774",
        "type": "YC",
        "balance": {
          "amount": 24.33
        },
        "token": {
          "value": "87743q5p3ffhv67y"
        }
      },
      "device": {
        "terminalId": "1742"
      },
      "merchant": {
        "mid": 15877,
        "name": "Merchant XYZ"
      },
      "server": {
        "name": "TM01CE"
      },
      "transaction": {
        "authSource": "E",
        "invoice": "0510093358",
        "responseCode": "A"
      }
    }
  ]
}