---
title: "Get QR code information about a scanned QR code, this information can be used to tailor wallet UI and enhance user experience"
method: GET
path: "/scan"
---

# Get QR code information about a scanned QR code, this information can be used to tailor wallet UI and enhance user experience

`GET /scan`

## Request

- Base URL: `//api.cryptoqr.net/scanner/v1` (relative, and the document’s source URL is not known)
- URL: `//api.cryptoqr.net/scanner/v1/scan`
- Auth: API key in header `X-API-Key`

## Query parameters

- `payload` string, required

## Response `200`

successful operation

- QrCodeInfo: Information about the QR code to be displayed to the user or used to enhance wallet UI/UX. Use as follows: - amountMin > 0 and amountMin == amountMax: The QR code is for a fixed amount payment, the wallet can immediately proceed to request payment instruction (scanQr) - amountMin > 0 and amountMin != amountMax: The QR code is for a range payment, e.g a bill with a tip. If amountMax is 0, the wallet should allow any amount greater than amountMin. - amountMin == 0 and amountMax == 0: The QR code is for an unspecified payment amount, the wallet should request that the user enter an amount. - orderReferenceRequired == true: The QR code is for a payment that requires an order reference. The wallet should request that the user enter an order reference.
  - `merchantName` string: Merchant name
  - `amountMin` integer: Minimum amount in cents, 0 for no minimum amount
  - `amountMax` integer: Maximum amount in cents, 0 for no maximum amount
  - `amountDefault` integer: Default amount in cents, 0 for no default amount. Show this as the default value in the amount input field.
  - `orderReferenceRequired` boolean: Whether an order reference is required. The order reference is a user-entered string that can be by the merchant to track the payment.
  - `orderReferenceDefault` string: Default order reference, if orderReferenceRequired is true. Show this as the default value in the order reference input field.
  - `tipEnabled` boolean: Whether the currrent payment supports tipping. Wallet should allow a tip to be set and added to the payment amount.
  - `currencyISOCode` string
  - `denomination` string: Denomination of the currency (usually cents)
  - `createdAt` string, date-time: Timestamp of when the QR code was created (if available)

## Other responses

- `400`: Bad Request
- `404`: Not Found

---

[API](https://skmtc.dev/moneybadger/apis/moneybadger-wallet-qr-scanner-api.md) - [All operations](https://skmtc.dev/moneybadger/apis/moneybadger-wallet-qr-scanner-api/llms.txt) - [OpenAPI document](https://skmtc.dev/moneybadger/apis/moneybadger-wallet-qr-scanner-api/revisions/e306b7643b61?raw)
