---
title: "reports that a QR code has been scanned by the partner app, obtain payment instructions specific to the wallet"
method: POST
path: "/scan"
---

# reports that a QR code has been scanned by the partner app, obtain payment instructions specific to the wallet

`POST /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`

## Request body

- Scan
  - `scan_id` string, required: a unique ID for the scan, preferably a UUID
  - `transaction_id` string: (Optional) A unique ID for the transaction, preferably a UUID. This ID may be specified by the API consumer when calling the /scan endpoint. This ID must be the reference that the Value Store uses to identify the transaction. if provided, the transaction_id will used to query payment status on the value store.
  - `time` string, date-time, required: The date and time of the message as recorded by the sender in ISO8601 format
  - `device_id` string, required: the device ID of the device that scanned the QR code, preferably a UUID
  - `user_id` string, required: the user ID of the user that scanned the QR code, preferably a UUID
  - `scan_data` string, required
  - `allowed_payment_methods` string[]
  - `payment_currencies` string[]: The currencies of the payment request that the receiver is able to to use for payment. optional, defaults to the default of the payment method
  - `payment_reference` string: The customer-supplied reference for the payment request
  - `requested_payment_amount` object
    - `currency` string, required: The currency code (e.g. BTC, ZAR)
    - `denomination` string, required: The denomination of the currency (e.g. cents, sats)
    - `amount` number, required: The payment amount in the specified denomination

## Response `200`

scan has been successfully processed

- PaymentRequest
  - `id` string: A unique ID that we assign to the payment request.
  - `created_at` string, date-time: ISO8601 timestamp at which the payment request was created
  - `amount_cents` integer: The amount of the payment request in the currency base unit (e.g. cents or sats)
  - `currency` string: The currency of the payment request that the receiver expects to receive
  - `status` 'REQUESTED' | 'AUTHORIZED' | 'CONFIRMED' | 'EXPIRED' | 'CANCELLED' | 'ERRORED': The current status of the payment request
  - `payment_methods` object: list of payment method types with payment instruction data the client can use to complete payment
  - `expiry_time` string: ISO8601 timestamp at which the payment request will expire
  - `merchant_name` string: Merchant name
  - `merchant_code` string: Merchant code
  - `merchant_category_code` string: Merchant category code
  - `order_description` string: Optional merchant provided order description
  - `notification_url` unknown
  - `merchant_info` object: Additional merchant information, structure depends on specific merchant.

## Other responses

- `400`: invalid input, object invalid
- `401`: unauthorized
- `403`: forbidden
- `409`: an existing item already exists
- `500`: internal server error
- `504`: gateway timeout

---

[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)
