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)
  • Auth
    API key in header X-API-Key

Query parameters

payloadstring required

QR code payload

Response

successful operation

merchantNamestring

Merchant name

amountMininteger

Minimum amount in cents, 0 for no minimum amount

amountMaxinteger

Maximum amount in cents, 0 for no maximum amount

amountDefaultinteger

Default amount in cents, 0 for no default amount. Show this as the default value in the amount input field.

orderReferenceRequiredboolean

Whether an order reference is required. The order reference is a user-entered string that can be by the merchant to track the payment.

orderReferenceDefaultstring

Default order reference, if orderReferenceRequired is true. Show this as the default value in the order reference input field.

tipEnabledboolean

Whether the currrent payment supports tipping. Wallet should allow a tip to be set and added to the payment amount.

currencyISOCodestring
denominationstring

Denomination of the currency (usually cents)

createdAtstring date-time

Timestamp of when the QR code was created (if available)

Changes

No recorded changes to this operation across all 1 revision of this API.