GET
/
qr
/
{shortCode}
Get QR code by short code
curl --request GET \
  --url https://api.simiz.io/v1/qr/{shortCode}
{
  "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "shortCode": "Qr12Ab34",
  "url": "https://pay.simiz.io/qr/Qr12Ab34",
  "name": "Store Counter QR",
  "description": "Scan to pay at counter",
  "type": "STATIC",
  "status": "ACTIVE",
  "fixedAmount": 5000,
  "maxAmount": null,
  "scanCount": 45,
  "lastScannedAt": "2024-01-15T14:20:00Z",
  "expiresAt": null,
  "createdAt": "2024-01-10T08:00:00Z",
  "updatedAt": "2024-01-15T14:20:00Z",
  "merchantName": "My Store",
  "merchantLogo": "https://cdn.simiz.io/logos/store.png",
  "projectId": "550e8400-e29b-41d4-a716-446655440000"
}

Path Parameters

​
shortCode
string
required

8-character alphanumeric short code

Example:

"Qr12Ab34"

Response

QR code details

​
id
string<uuid>
​
shortCode
string

8-character alphanumeric code used in the URL

Example:

"Qr12Ab34"

​
url
string<uri>

Full QR code URL

Example:

"https://pay.simiz.io/qr/Qr12Ab34"

​
name
string

QR code name

Example:

"Store Counter QR"

​
description
string | null

Optional description

​
type
enum<string>

QR code type:

  • STATIC — Fixed amount, reusable
  • DYNAMIC — Variable amount, single use
Available options:
STATIC,
DYNAMIC
​
status
enum<string>

QR code lifecycle:

  • ACTIVE — Active and scannable
  • PAUSED — Temporarily disabled by the merchant
  • EXPIRED — Past expiration date
  • REVOKED — Permanently revoked
Available options:
ACTIVE,
PAUSED,
EXPIRED,
REVOKED
​
fixedAmount
number | null

Fixed payment amount for STATIC QR codes

Example:

5000

​
maxAmount
number | null

Maximum allowed amount for DYNAMIC QR codes

​
scanCount
integer

Total number of times this QR code has been scanned

​
lastScannedAt
string<date-time> | null

Timestamp of the last scan

​
expiresAt
string<date-time> | null

Expiration date, or null if the QR code does not expire

​
createdAt
string<date-time>
​
updatedAt
string<date-time>
​
merchantName
string

Organization name (only included on public endpoint)

​
merchantLogo
string | null

Organization logo URL (only included on public endpoint)

​
projectId
string<uuid>

Project UUID (only included on public endpoint)