Developers
V1PlatformMerchantsTenantidScan links

Platform admin: list booth scan links

Status, expiry, outlet and device counts. No token or PIN is ever returned again after creation.

GET
/v1/platform/merchants/{tenantId}/scan-links

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

tenantId*string
Match^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/platform/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/scan-links"
{  "links": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "label": "string",      "outletId": "414ee52f-b8bb-444c-8e1a-824bf463e887",      "outletName": "string",      "status": "active",      "expiresAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "rotatedAt": "2019-08-24T14:15:22Z",      "revokedAt": "2019-08-24T14:15:22Z",      "activeDevices": 0,      "lastUsedAt": "2019-08-24T14:15:22Z"    }  ]}

Record what was checked: SSM verified, clinic licence number, issuing body and expiry PATCH

Identifiers only; no document is stored. Needs the merchants Manage permission and a fresh password or email-code session. Enter the licence number, issuing body and expiry date together or leave all three empty. verifiedBy and verifiedAt are set by the server from the signed-in administrator. 409 merchant_verification_changed when expectedVersion is out of date (0 for the first record).

Platform admin: create a booth scan link and PIN POST

Returns the link token and six digit PIN once; only hashes are stored. The link lets promoters validate and redeem this merchant's (or one outlet's) vouchers on a phone without signing in, after entering the PIN once per device. The default end is the last collect-by date of the merchant's published offers; a later date may be set (up to 399 days). At most 20 live links per merchant. Needs a recent sign-in (last 30 minutes).