# Get QR Details

This endpoint is used to get detailed information for a transaction based QR code.


- 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.


Endpoint: POST /qrpayments/getqrdetails
Version: 1.7.43
Security: AccessToken

## Header parameters:

  - `InterfaceVersion` (string, required)
    Refers to the version of the program or application that is sending requests to Shift4. The following special characters are not allowed:  $ % : ^ - ~  , ? “ ” ‘ ’ { } [ ] \ + =
    Example: "2.1"

  - `InterfaceName` (string, required)
    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"

  - `CompanyName` (string, required)
    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"

  - `AccessToken` (string, required)
    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  and .
    Example: "EA79FB05-3AA7-4500-AF9A-73F986FF2C1D"

## Request fields (application/json):

  - `dateTime` (string, required)
    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

  - `qrCode` (object, required)

  - `qrCode.value` (string, required)
    Contains the QR Code URL string. This must match the value received in the [Get QR Code](/apis/payments-platform-rest/openapi/qr-payments/getqrcode) response.

## Response 200 fields (application/json):

  - `result` (array)

  - `result.dateTime` (string)
    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

  - `result.amount` (object)

  - `result.amount.total` (number)
    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.

  - `result.amount.tax` (number)
    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.

  - `result.amount.tip` (number)
    The tip amount of the transaction.

  - `result.amount.cashback` (number)
    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  and including it in the  field. This will bypass prompting the consumer for a cashback amount.

  - `result.transaction` (object)

  - `result.transaction.invoice` (string)
    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.

  - `result.transaction.saleFlag` (string)
    Specifies a transaction is a sale (‘S’) or authorization (‘A’).  Value sent in the [Get QR Code](/apis/payments-platform-rest/openapi/qr-payments/getqrcode) request will be returned in the [Get QR Details](/apis/payments-platform-rest/openapi/qr-payments/getqrdetails) response.
    Enum: "A", "S"

  - `result.transaction.vendorReference` (string)
    Optional field for information that can be searched in the merchant portal.

  - `result.merchant` (object)

  - `result.merchant.addressLine1` (string)
    First line in the merchant’s business address as configured with Shift4.

  - `result.merchant.addressLine2` (string)
    Second line in the merchant’s business address as configured with Shift4.

  - `result.merchant.city` (string)
    City of the merchant’s business address as configured with Shift4.

  - `result.merchant.dayEndingTime` (string)
    The time the merchant’s business day ends as configured with Shift4.

  - `result.merchant.industry` (string)
    Classifies the merchant type for a merchant’s account with Shift4.

Value|Description
-----|-----------
A    | Auto Rental
F    | Food & Beferage (F&B)
H    | Hotel
M    | Mail order/Telephone Order (MOTO) or E-Commerce
R    | Retail
P    | Passenger Transport
    Enum: "A", "F", "H", "M", "R", "P"

  - `result.merchant.name` (string)
    The merchant’s business name as configured with Shift4.

  - `result.merchant.region` (string)
    Region (State) of the merchant’s business address as configured with Shift4.

  - `result.merchant.phone` (string)
    The merchant’s business telephone number as configured with Shift4.

  - `result.merchant.postalCode` (string)
    ZIP/Postal Code of the merchant’s business address as configured with Shift4.

  - `result.merchant.serialNumber` (string)
    The serial number of the merchant's account with Shift4.

  - `result.merchant.mid` (number)
    The merchant ID associated with the merchant account.

  - `result.merchant.cardTypes` (array)
    Array of Merchant Card Types

  - `result.merchant.cardTypes.type` (string)
    An abbreviation used to specify the type of card that was used when processing a transaction.

Value| Description
-----|------------
AX   | American Express
AP   | Alipay
BC   | Backed Card       
CI   | Citgo        
DB   | Debit card
GC   | Gift Card
JC   | JCB
MC   | Mastercard
NS   | Discover/JCB/Novus
PL   | Private Label
SC   | Sears Canada
VS   | Visa
WP   | WeChat Pay
YC   | IT’S YOUR CARD
    Enum: "AX", "AP", "BC", "CI", "DB", "GC", "JC", "MC", "NS", "PL", "SC", "VS", "WP", "YC"

  - `result.merchant.cardTypes.voiceCenter` (object)

  - `result.merchant.cardTypes.voiceCenter.accountNumber` (string)
    The merchant’s account number as configured with Shift4. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request because the clerk is required to provide it when attempting to obtain a voice authorization code. This information must be displayed to the clerk.

  - `result.merchant.cardTypes.voiceCenter.phoneNumber` (string)
    The phone number a clerk must call to obtain a voice authorization code. This field is returned in response to a [Merchant Information](/apis/payments-platform-rest/openapi/merchants/merchantsmerchant) request. This information must be displayed to the clerk.

  - `result.qrPayConfig` (object)

  - `result.qrPayConfig.splitEnabled` (string)
    Specifies whether split check processing is enabled or disabled for QR Code Payments

Value|Description
-----|-----------
Y    | Split check proessing is enabled.
N    | Split check proessing is disabled.
    Enum: "Y", "N"

  - `result.qrPayConfig.tipEnabled` (string)
    Specifies whether tip prompting is enabled or disabled for the merchant

Value|Description
-----|-----------
Y    | Tip prompting is enabled.
N    | Tip prompting is disabled.
    Enum: "Y", "N"

  - `result.qrPayConfig.tipPresets` (array)
    Tip preset percentages configured by the merchant.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.

  - `result.credential` (object)

  - `result.credential.accessToken` (string)
    A security credential used to authenticate API requests and all [i4Go®](https://s4-myportal.s3.amazonaws.com/downloads/documentation/i4go/i4go%20technical%20reference%20guide.pdf) 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](/apis/payments-platform-rest/openapi/credentials/accesstokenexchange) request, which generates an Access Token using an  and .

  - `result.credential.apiSerialNumber` (string)
    The serial number for the merchant account. This field is only used for backwards compatibility with older interfaces and has been replaced by the Access Token.

## Response 400 fields (application/json):

  - `result` (array)

  - `result.error` (object)

  - `result.error.code` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.severity` (string)
    Severity level of the error.

| Severity | Description                                                       |
| -------- | ----------------------------------------------------------------  |
| Info     | Action not required - Data input/formatting is incorrect          |
| Error    | Action may be required - Communication, timeout or network issue  |
| Alert    | Action required - System issue                                    |
    Enum: "Info", "Error", "Alert"

  - `result.error.shortText` (string)
    Abbreviated error message that is always returned if an error condition exists

  - `result.error.longText` (string)
    Extended error message that is returned if an error condition exists.

  - `result.error.primaryCode` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.secondaryCode` (integer)
    This code supplements the code specified in the  field to provide additional information about the error that occurred.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.

## Response 504 fields (application/json):

  - `result` (array)

  - `result.error` (object)

  - `result.error.code` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.severity` (string)
    Severity level of the error.

| Severity | Description                                                       |
| -------- | ----------------------------------------------------------------  |
| Info     | Action not required - Data input/formatting is incorrect          |
| Error    | Action may be required - Communication, timeout or network issue  |
| Alert    | Action required - System issue                                    |
    Enum: "Info", "Error", "Alert"

  - `result.error.shortText` (string)
    Abbreviated error message that is always returned if an error condition exists

  - `result.error.longText` (string)
    Extended error message that is returned if an error condition exists.

  - `result.error.primaryCode` (integer)
    Code indicating the type of error that occurred. Refer to the [Error Codes](/guides/appendices/error-codes) section of this document for more details.

  - `result.error.secondaryCode` (integer)
    This code supplements the code specified in the  field to provide additional information about the error that occurred.

  - `result.lighthouse` (object)

  - `result.lighthouse.data` (string)
    Base64 encoded JSON formatted data that will be returned from Lighthouse to be passed back to SkyTab. This data will contain variable information.

  - `result.server` (object)

  - `result.server.name` (string)
    The name of the server that processed the request.