The amount being charged for a particular transaction. If other amount fields are sent, they must be included in the total amount. Amount cannot be zero.
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 endpoint is used to obtain a transaction based QR code.
Integration Methods:
- Host Direct
- Locally Installed UTG
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Security
AccessToken
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
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.
Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
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
The amount of sales tax charged for a transaction. The tax amount is used by businesses to track tax expenses for accounting purposes. Identifying the tax amount also helps consumers understand the total amount that they were billed. This field is part of Level 2 card data.
Conditional: Send in the request if a tip is included.
The tip amount of the transaction.
Specifies the cashback amount in a transaction. When using a UTG-controlled PIN pad with the ALLOWCASHBACK API Option, this field will return the cashback amount requested by the consumer. The interface can also send the desired cashback amount in a request by adding it to the amount.total and including it in the amount.cashback field. This will bypass prompting the consumer for a cashback amount.
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.
Specifies a transaction is a sale (‘S’) or authorization (‘A’). Value sent in the Get QR Code request will be returned in the Get QR Details response.
Enum"A""S"
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/qrpayments/getqrcode
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/qrpayments/getqrcode
- Locally Installed UTG URL
https://192.168.1.10:277/api/rest/v1/qrpayments/getqrcode
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "amount": { "total": 160, "tax": 15, "tip": 20, "cashback": 20 }, "transaction": { "invoice": "0510093358", "saleFlag": "S", "vendorReference": "12382-01" } }
Response
application/json
{ "result": [ { "dateTime": "2024-05-21T09:18:23.283-07:00", "qrCode": { "value": "https://pay.skytab.com/A3KD42J" }, "server": { "name": "TM01CE" }, "amount": { "total": 160, "tax": 15, "tip": 20, "cashback": 20 }, "merchant": { "mid": 15877, "name": "Merchant XYZ" }, "transaction": { "invoice": "0510093358", "saleFlag": "S", "vendorReference": "12382-01", "responseCode": "A" } } ] }
Request
This endpoint is used to get detailed information for a transaction based QR code.
Integration Methods:
- Host Direct
- Locally Installed UTG
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Security
AccessToken
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
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.
Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
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
Contains the QR Code URL string. This must match the value received in the Get QR Code response.
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/qrpayments/getqrdetails
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/qrpayments/getqrdetails
- Locally Installed UTG URL
https://192.168.1.10:277/api/rest/v1/qrpayments/getqrdetails
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "qrCode": { "value": "https://pay.skytab.com/A3KD42J" } }
Response
application/json
{ "result": [ { "dateTime": "2024-05-21T09:18:23.283-07:00", "amount": { "total": 160, "tax": 15, "tip": 20, "cashback": 20 }, "transaction": { "invoice": "0510093358", "saleFlag": "S", "vendorReference": "12382-01" }, "merchant": { "addressLine1": "456 Fake St", "addressLine2": "Suite 100", "city": "Las Vegas", "dayEndingTime": "010000", "industry": "F", "name": "Merchant XYZ", "region": "NV", "phone": "702-123-4567", "postalCode": "78402", "serialNumber": "00000044444", "mid": 15877, "cardTypes": [ … ] }, "qrPayConfig": { "splitEnabled": "Y", "tipEnabled": "Y", "tipPresets": [ … ] }, "server": { "name": "TM01CE" }, "credential": { "accessToken": "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D", "apiSerialNumber": "266" } } ] }
Request
This endpoint is used to poll for the status of the QR code payment.
Integration Methods:
- Host Direct
- Locally Installed UTG
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Security
AccessToken
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
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.
Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
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
Contains the QR Code URL string. This must match the value received in the Get QR Code response.
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/qrpayments/getqrpaymentstatus
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/qrpayments/getqrpaymentstatus
- Locally Installed UTG URL
https://192.168.1.10:277/api/rest/v1/qrpayments/getqrpaymentstatus
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "qrCode": { "value": "https://pay.skytab.com/A3KD42J" } }
Response
application/json
{ "result": [ { "dateTime": "2021-04-15T09:18:23.283-07:00", "amount": { "cashback": 20, "tax": 15, "tip": 20, "total": 160 }, "card": { "entryMode": "1", "expirationDate": 1222, "number": "XXXXXXXXXXXX1119", "present": "N", "token": { … }, "type": "VS" }, "clerk": { "numericId": 1576 }, "customer": { "firstName": "John", "lastName": "Smith" }, "merchant": { "mid": 15877, "name": "Merchant XYZ" }, "receipt": [ { … }, { … }, { … }, { … } ], "server": { "name": "UTGAPI01CE" }, "transaction": { "authorizationCode": "OK126Z", "authSource": "E", "invoice": "192029", "responseCode": "A", "saleFlag": "S" } } ] }
Request
This endpoint is used to cancel a QR code payment. If the payment was already processed the transaction will be reversed. If the payment has not yet processed it will prevent the QR code from being used to process a payment.
Integration Methods:
- Host Direct
- Locally Installed UTG
See the Integration Methods and URLs Section sections of the Development Quick Start guide for details regarding each processing option.
Security
AccessToken
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
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.
Example: EA79FB05-3AA7-4500-AF9A-73F986FF2C1D
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
Contains the QR Code URL string. This must match the value received in the Get QR Code response.
- Host Direct Test URL
https://api.shift4test.com/api/rest/v1/qrpayments/cancelqrpayment
- Host Direct Production URL
https://api.shift4api.net/api/rest/v1/qrpayments/cancelqrpayment
- Locally Installed UTG URL
https://192.168.1.10:277/api/rest/v1/qrpayments/cancelqrpayment
- Payload
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
application/json
{ "dateTime": "2024-05-21T09:18:23.283-07:00", "qrCode": { "value": "https://pay.skytab.com/A3KD42J" } }
Response
application/json
{ "result": [ { "dateTime": "2024-05-21T09:18:23.283-07:00", "transaction": { "responseCode": "C" }, "merchant": { "serialNumber": "00000044444", "mid": 15877, "name": "Merchant XYZ" }, "server": { "name": "TM01CE" } } ] }