---
title: "Get QR Details"
method: POST
path: "/qrpayments/getqrdetails"
tags: ["QR Payments"]
---

# Get QR Details

`POST /qrpayments/getqrdetails`

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](/guides/quickstart#integration-methods) and [URLs Section](/guides/quickstart#urls) sections of the Development Quick Start guide for details regarding each processing option.

## Headers

- `InterfaceVersion` string, required
- `InterfaceName` string, required
- `CompanyName` string, required
- `AccessToken` string, uuid, required

## Request body

- object
  - `dateTime` string, ISO 8601, 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` QRCodeRequest, required
    - `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`

Request was processed

- object
  - `result` object[]
    - `dateTime` string, ISO 8601 — 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
    - `amount` object
      - `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.
      - `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.
      - `tip` number — **Conditional: Send in the request if a tip is included.** The tip amount of the transaction.
      - `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 `amount.total` and including it in the `amount.cashback` field. This will bypass prompting the consumer for a cashback amount.
    - `transaction` object
      - `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. **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.**
      - `saleFlag` 'A' | 'S' — 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.
      - `vendorReference` string — Optional field for information that can be searched in the merchant portal.
    - `merchant` object
      - `addressLine1` string — First line in the merchant’s business address as configured with Shift4.
      - `addressLine2` string — Second line in the merchant’s business address as configured with Shift4.
      - `city` string — City of the merchant’s business address as configured with Shift4.
      - `dayEndingTime` string — The time the merchant’s business day ends as configured with Shift4. **Note: This is only applicable for merchants based in the USA. If the merchant is not based in the USA, this field will not be returned.**
      - `industry` 'A' | 'F' | 'H' | 'M' | 'R' | 'P' — 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
      - `name` string — The merchant’s business name as configured with Shift4.
      - `region` string — Region (State) of the merchant’s business address as configured with Shift4.
      - `phone` string — The merchant’s business telephone number as configured with Shift4.
      - `postalCode` string — ZIP/Postal Code of the merchant’s business address as configured with Shift4.
      - `serialNumber` string — The serial number of the merchant's account with Shift4.
      - `mid` number — The merchant ID associated with the merchant account.
      - `cardTypes` MerchantCardTypes[] — Array of Merchant Card Types
        - `type` 'AX' | 'AP' | 'BC' | 'CI' | 'DB' | 'GC' | 'JC' | 'MC' | 'NS' | 'PL' | 'SC' | 'VS' | 'WP' | 'YC' — 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
        - `voiceCenter` 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.
          - `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.
    - `qrPayConfig` QRPayConfig
      - `splitEnabled` 'Y' | 'N' — 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.
      - `tipEnabled` 'Y' | 'N' — Specifies whether tip prompting is enabled or disabled for the merchant Value|Description -----|----------- Y | Tip prompting is enabled. N | Tip prompting is disabled.
      - `tipPresets` string[] — Tip preset percentages configured by the merchant.
    - `server` Server
      - `name` string — The name of the server that processed the request.
    - `credential` object
      - `accessToken` string, uuid — 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 `authToken` and `clientGuid`.
      - `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.
      - `apiPassword` string, uuid — A unique encrypted identifier that refers to a specific merchant account. It is required when making an [Access Token Exchange](/apis/payments-platform-rest/openapi/credentials/accesstokenexchange) request. For detailed information about the AuthToken, please see [Authentication](/guides/quickstart#access-token-exchange)

## Other responses

- `400` — Error
- `504` — Timeout

---

[API](https://skmtc.dev/shift4/apis/shift4-payment-api.md) · [All operations](https://skmtc.dev/shift4/apis/shift4-payment-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/shift4/shift4-payment-api/revisions/2f85c87cc9e5/schema)