Vouchify
Token console

Quick links

Quickstart GuideAPI reference 66 endpointsAuthentication GuideScopes & presets 32 scopesToken lifecycle GuideErrors ReferenceToken console Tool
↑↓ Navigate↵ OpenEsc Close
Documentation menu
QuickstartAuthenticationScopes & presetsToken lifecycleErrorsSecurityJWT & other authAPI referenceToken console

66 scoped endpoints · API v1

API reference

Explore every business route currently enabled for merchant API tokens. Filter by resource, method, or scope, then compose a real request in the playground.

/

Truthful by design. The merchant-token contract publishes methods, paths, scopes, and security boundaries, but not feature request/response schemas. Unpublished fields are clearly marked rather than invented.

Dashboard

2

Merchant metrics and dashboard-linked user detail.

GET/merchant/stats

Read merchant dashboard statistics.

dashboard:read
GET/merchant/users/:userId

Read dashboard-linked detail for a merchant user.

dashboard:read

Billing

3

Billing overview, usage, and invoice reads.

GET/merchant/billing

Read the merchant billing overview.

billing:read
GET/merchant/billing/usage

Read merchant billing usage.

billing:read
GET/merchant/billing/invoices

List merchant billing invoices.

billing:read

Vouchers

7

Voucher catalog, communication, and redemption.

GET/merchant/vouchers

List merchant vouchers.

vouchers:read
GET/merchant/vouchers/:id

Inspect one merchant voucher record.

vouchers:read
PATCH/merchant/vouchers/:id

Update one merchant voucher record.

vouchers:update
DELETE/merchant/vouchers/:id

Delete one merchant voucher record.

vouchers:delete
POST/merchant/vouchers/broadcast

Broadcast to voucher recipients.

vouchers:communicate
POST/merchant/nudge/:voucherId

Nudge a voucher recipient.

vouchers:communicate
POST/vouchers/:id/redeem

Redeem one merchant voucher.

vouchers:redeem

Merchant

1

Merchant-owned profile settings.

PATCH/merchant/profile

Update owner-allowed merchant profile settings.

merchant:write

Groups

4

Merchant group, related merchant, availability, and request reads.

GET/merchant/group

Read merchant group information.

groups:read
GET/merchant/group/related-merchants

List merchants related through the merchant group.

groups:read
GET/merchant/group/available

List available merchant group information.

groups:read
GET/merchant/group/requests

List merchant group requests.

groups:read

Team

1

Read access to delegator information.

GET/merchant/delegators

List merchant delegator information where enabled.

team:read

Memberships

24

Pass templates, issued passes, redemption, lifecycle, and communication.

GET/memberships/pass-templates

List membership pass templates.

memberships:read
GET/memberships/pass-templates/:templateId

Read one membership pass template.

memberships:read
POST/memberships/pass-templates

Create a membership pass template.

memberships:create
PATCH/memberships/pass-templates/:templateId

Update one membership pass template.

memberships:update
DELETE/memberships/pass-templates/:templateId

Delete one membership pass template.

memberships:delete
GET/memberships/passes/merchant

List membership passes for the authenticated merchant.

memberships:read
GET/memberships/passes/:passId

Read one membership pass.

memberships:read
POST/memberships/passes

Create a membership pass.

memberships:create
PATCH/memberships/passes/:passId

Update one membership pass.

memberships:update
DELETE/memberships/passes/:passId

Delete one membership pass.

memberships:delete
POST/memberships/merchant/issue

Issue a membership pass as the authenticated merchant.

memberships:issue
POST/memberships/lookup

Look up a membership pass.

memberships:read
POST/memberships/redeem

Redeem a membership pass.

memberships:redeem
POST/memberships/redeem-points

Redeem membership points.

memberships:redeem
GET/memberships/merchant

Read merchant membership information.

memberships:read
GET/memberships/merchant/pass/:passId/stats

Read statistics for a merchant membership pass.

memberships:read
GET/memberships/merchant/pass/:passId/issued

List issued records for a merchant membership pass.

memberships:read
POST/memberships/merchant/pass/:passId/broadcast

Broadcast a membership pass communication.

memberships:communicate
POST/memberships/merchant/:id/email

Send a membership communication by email.

memberships:communicate
PATCH/memberships/merchant/:id/pause

Pause a merchant membership record.

memberships:update
PATCH/memberships/merchant/:id/resume

Resume a merchant membership record.

memberships:update
PATCH/memberships/merchant/:id/revoke

Revoke a merchant membership record.

memberships:update
GET/memberships/merchant/stats

Read merchant membership statistics.

memberships:read
GET/memberships/merchant/activity

Read merchant membership activity.

memberships:read

Posts

7

Merchant post creation, updates, deletion, comments, and likes.

POST/posts

Create a merchant post.

posts:create
PATCH/posts/:postId

Update one merchant post.

posts:update
DELETE/posts/:postId

Delete one merchant post.

posts:delete
POST/posts/:postId/comments

Create a comment on a post.

posts:interact
DELETE/posts/comments/:commentId

Delete a post comment.

posts:interact
POST/posts/:postId/like

Toggle the supported like interaction on a post.

posts:interact
POST/posts/comments/:commentId/like

Toggle the supported like interaction on a comment.

posts:interact

Notifications

6

Recipient-constrained notification reads and management.

GET/notifications

List notifications for the authenticated recipient.

notifications:read
GET/notifications/unread-count

Read the authenticated recipient's unread notification count.

notifications:read
POST/notifications/:id/mark-as-read

Mark one notification as read.

notifications:manage
POST/notifications/mark-all-as-read

Mark all authenticated-recipient notifications as read.

notifications:manage
POST/notifications/:id/delete

Delete one notification.

notifications:manage
POST/notifications/delete-all

Delete all authenticated-recipient notifications.

notifications:manage

Wallet

4

Read-only wallet details, transactions, statistics, and export.

GET/wallets/me

Read the authenticated merchant wallet.

wallet:read
GET/wallets/me/transactions

List transactions for the authenticated merchant wallet.

wallet:read
GET/wallets/me/stats

Read statistics for the authenticated merchant wallet.

wallet:read
GET/wallets/me/transactions/export

Export authenticated merchant wallet transactions.

wallet:read

KYB

2

Read-only business verification status and details.

GET/merchants/kyb/status

Read merchant KYB status.

kyb:read
GET/merchants/kyb/details

Read merchant KYB details.

kyb:read

Approved uploads

4

Logo, banner, membership-pass, and gallery imagery.

POST/uploads/logo

Upload approved merchant logo imagery.

uploads:write
POST/uploads/banner

Upload approved merchant banner imagery.

uploads:write
POST/uploads/membership-pass-images

Upload approved membership pass imagery.

uploads:write
POST/uploads/gallery

Upload approved merchant gallery imagery.

uploads:write

Referrals

1

Authenticated merchant referral summary.

GET/referrals/merchant/me

Read the authenticated merchant referral summary.

referrals:read