Developers
V1PlatformMerchantsIdOnboarding

Platform: one merchant's progress from invitation to first redemption, with their vouchers

Invite accepted, listing live, vouchers live, scanner link, first claim and first redemption, each with a time when done; and every voucher with its branches, eligibility, status and counts. Counts only.

GET
/v1/platform/merchants/{id}/onboarding

Authorization

bearer
AuthorizationBearer <token>

In: header

Path Parameters

id*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

curl -X GET "https://example.com/v1/platform/merchants/497f6eca-6276-4993-bfeb-53cbbbba6f08/onboarding"
{  "tenantId": "f97df110-f4de-492e-8849-4a6af68026b0",  "steps": {    "inviteAccepted": {      "done": true,      "at": "2019-08-24T14:15:22Z"    },    "listingLive": {      "done": true,      "at": "2019-08-24T14:15:22Z",      "status": "none",      "branchCount": 0    },    "vouchersLive": {      "done": true,      "live": 0,      "awaitingReview": 0,      "changesRequested": 0,      "draft": 0,      "total": 0    },    "scannerLink": {      "done": true,      "at": "2019-08-24T14:15:22Z",      "count": 0    },    "firstClaim": {      "done": true,      "at": "2019-08-24T14:15:22Z"    },    "firstRedemption": {      "done": true,      "at": "2019-08-24T14:15:22Z"    }  },  "vouchers": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "title": "string",      "status": "draft",      "version": 0,      "eligibility": "signup",      "signupWithinDays": -9007199254740991,      "outlets": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "name": "string"        }      ],      "allOutlets": true,      "submittedAt": "2019-08-24T14:15:22Z",      "claimsStoppedAt": "2019-08-24T14:15:22Z",      "claimedCount": 0,      "redeemedCount": 0    }  ]}

Suspend or reactivate an activated merchant workspace POST

Previous Page

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