yusker
Request API access

API reference

REST APIs with predictable resource-oriented URLs, JSON bodies, and standard status codes.

Venue API Live

Base URL https://api.yusker.com/partner/v1 · auth Authorization: Bearer yk_… (keys from the business portal) · amounts in cents · 120 requests/min per key.

Account

GET/partner/v1/me
Account guide →

Venues & menus

GET/partner/v1/venues
GET/partner/v1/venues/{venue_id}/menu
PATCH/partner/v1/venues/{venue_id}/menu/items/{item_id}
Venues & menus guide →

Orders

GET/partner/v1/venues/{venue_id}/orders
GET/partner/v1/orders/{order_id}
Orders guide →

Payments API Preview

PreviewThe Payments API is in a design-partner preview and not yet publicly callable — endpoints and shapes may change. Request access to join the program. Building a venue integration today? Use the live Venue API.

Base URL https://api.yusker.com/v1 · HTTP Basic auth.

Conventions

  • All amounts are integers in the smallest currency unit (cents).
  • Timestamps are ISO-8601 UTC. IDs are prefixed by type (ID, MU, PI, TR).
  • Send Idempotency-ID on writes to make retries safe.
  • Errors return a JSON body with code and message; 2xx success, 4xx client error, 5xx Yusker error.

Identities

POST/v1/identities
GET/v1/identities/{id}
POST/v1/identities/{id}/merchants
Identities guide →

Merchants

GET/v1/merchants/{id}
GET/v1/merchants
Merchants guide →

Payment Instruments

POST/v1/payment_instruments
GET/v1/payment_instruments/{id}
Payment Instruments guide →

Transfers

POST/v1/transfers
GET/v1/transfers/{id}
POST/v1/transfers/{id}/reversals
Transfers guide →

Webhooks

POST/v1/webhooks
GET/v1/webhooks
Webhooks guide →

Errors

{
  "code": "invalid_request",
  "message": "amount must be a positive integer",
  "field": "amount"
}
  • 400 invalid_request — malformed or missing parameters.
  • 401 unauthenticated — missing or invalid API key.
  • 402 charge_declined — the issuer declined the card.
  • 403 forbidden — the key lacks access to the resource.
  • 404 not_found — no such resource.
  • 409 conflict — idempotency or state conflict.
  • 429 rate_limited — slow down and retry with backoff.
Previous
Testing