> ## Documentation Index > Fetch the complete documentation index at: https://developers.perkstar.co.uk/llms.txt > Use this file to discover all available pages before exploring further. # Send a wallet push > Sends a marketing wallet push to a specific enrolment. The customer must have push-marketing consent enabled, otherwise the endpoint returns 403 with `push_marketing_consent_required`. Merge fields (`{firstName}`, `{balance}`, `{installLink}`, `{shareLink}`, `{cardName}`, `{orgName}`) are resolved against the targeted customer + enrolment + card. Throttle: 3-minute per-card cooldown. Hit → 429 with `Retry-After`. The cooldown is shared with the operator's dashboard push paths so a rapid dashboard + API sequence is also caught. Test mode (`pk_test_…` or OAuth `mode=TEST`): the endpoint returns 200 with `test_mode: true` but does NOT push. Lets partners verify wire integration without spamming real customer lock screens. ## OpenAPI ````yaml /api/openapi.yaml post /pushes openapi: 3.1.0 info: title: Perkstar Public REST API version: 2026-05-04.oauth description: | Programmatic access to your Perkstar loyalty data. Two authentication modes are supported: - **API key.** Per-org bearer token issued from Settings → API keys (`pk_live_…` / `pk_test_…`). Right choice for direct integrations, single-tenant POS adapters, and back-office sync. - **OAuth 2.0.** Three-legged authorization-code flow with PKCE, for marketplace listings (Square App Marketplace, Shopify App Store, Toast Partner Marketplace, Lightspeed). The merchant installs your app from the partner marketplace, lands on `/oauth/authorize`, approves the requested scopes, and your server exchanges the code at `/api/oauth/token` for a short-lived access token. See the dedicated OAuth section below. Every endpoint is scoped, rate-limited, and idempotent on POST. POS-adapter builders should start with the `/marketplace/*` endpoints — they collapse the typical "find-or-create customer + enrolment + post transaction" flow into a single round-trip with permanent dedupe via `external_transaction_id`. ## Test credentials Test credentials (`pk_test_…` or OAuth applications in TEST mode) can read API data, create isolated test transactions, and simulate wallet pushes. They cannot create, update, or delete live customers, enrolments, or webhook configuration. Test calls to `/marketplace/accrue` only work with an existing customer and enrolment; `/marketplace/enroll` is live-only. This prevents a sandbox integration from changing live customer records. Copy-paste cURL recipes are published at `/api/v1/curl-recipes.md` for teams that want to test the API before wiring the SDK. ## Response headers (universal) Every response, success or error, carries: - **X-Request-Id** — unique per request. Echo this in support tickets; we can find the exact call in the per-key audit log. - **X-API-Version** — date-versioned schema marker (`2026-05-04` as of writing). 12-month deprecation policy. - **X-RateLimit-Limit** — per-minute quota for the credential. - **X-RateLimit-Remaining** — tokens left in the current window. - **X-RateLimit-Reset** — unix-seconds when the window refills. - **Retry-After** — emitted on 429 only; seconds to wait. The reusable error responses below (`Unauthorized`, `Forbidden`, `NotFound`, `RateLimited`, `ValidationError`) declare these as strongly-typed `headers` so codegen against an error path has them. Success responses inline their `"200"` / `"201"` and rely on this convention rather than per-endpoint header declarations. contact: name: Perkstar url: https://perkstar.co.uk servers: - url: https://dashboard.perkstar.co.uk/api/v1 description: Production security: - bearerAuth: [] paths: /pushes: post: tags: - Pushes summary: Send a wallet push description: | Sends a marketing wallet push to a specific enrolment. The customer must have push-marketing consent enabled, otherwise the endpoint returns 403 with `push_marketing_consent_required`. Merge fields (`{firstName}`, `{balance}`, `{installLink}`, `{shareLink}`, `{cardName}`, `{orgName}`) are resolved against the targeted customer + enrolment + card. Throttle: 3-minute per-card cooldown. Hit → 429 with `Retry-After`. The cooldown is shared with the operator's dashboard push paths so a rapid dashboard + API sequence is also caught. Test mode (`pk_test_…` or OAuth `mode=TEST`): the endpoint returns 200 with `test_mode: true` but does NOT push. Lets partners verify wire integration without spamming real customer lock screens. operationId: sendPush parameters: - $ref: '#/components/parameters/IdempotencyKey' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PushCreate' responses: '200': description: Test-mode push (no actual delivery) content: application/json: schema: $ref: '#/components/schemas/PushResult' '201': description: Push queued content: application/json: schema: $ref: '#/components/schemas/PushResult' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimited' security: - bearerAuth: [] components: parameters: IdempotencyKey: in: header name: Idempotency-Key schema: type: string maxLength: 255 description: | Replay-safe request key. Repeated requests with the same value within 24h return the original response unchanged. schemas: PushCreate: type: object required: - enrollment_id - message properties: enrollment_id: type: string description: | The enrolment to target. The push fans out across every wallet pass on the customer's physical device (siblings with the same `deviceFingerprint`), so multiple cards on one phone share the message. message: type: string minLength: 1 maxLength: 180 description: | Plain-text push body. Merge fields are resolved: `{firstName}`, `{lastName}`, `{balance}`, `{cardName}`, `{installLink}`, `{shareLink}`, `{orgName}`. metadata: type: object additionalProperties: true description: | Free-form key/value bag for partner-side context. Not persisted beyond the audit row. PushResult: type: object properties: id: type: string nullable: true description: | Broadcast audit row id. Null on test-mode calls (no row written). delivered: type: boolean description: | True when every attempted platform succeeded. False if any APNs / Google send failed — the message still landed on the pass copy + audit row. target_enrollment_ids: type: array items: type: string description: | Enrolment ids touched, including sibling-device-fingerprint fan-out beyond the supplied `enrollment_id`. platforms_attempted: type: integer description: | Count of (pass × platform) deliveries attempted. Zero in test mode. platforms_failed: type: integer test_mode: type: boolean description: | True when the caller used a `pk_test_…` key or an OAuth `mode=TEST` token. No wallet push is actually fired and no Broadcast row is written. Error: type: object properties: error: type: object required: - type - message - code properties: type: type: string enum: - authentication_error - permission_error - rate_limit_error - validation_error - not_found - idempotency_error - server_error message: type: string code: type: string param: type: string responses: Unauthorized: description: Missing / invalid / expired API key headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-API-Version: $ref: '#/components/headers/XAPIVersion' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' Forbidden: description: API key is missing the required scope headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-API-Version: $ref: '#/components/headers/XAPIVersion' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' NotFound: description: Resource not found headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-API-Version: $ref: '#/components/headers/XAPIVersion' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' content: application/json: schema: $ref: '#/components/schemas/Error' RateLimited: description: Per-key rate limit exceeded headers: X-Request-Id: $ref: '#/components/headers/XRequestId' X-API-Version: $ref: '#/components/headers/XAPIVersion' X-RateLimit-Limit: $ref: '#/components/headers/XRateLimitLimit' X-RateLimit-Remaining: $ref: '#/components/headers/XRateLimitRemaining' X-RateLimit-Reset: $ref: '#/components/headers/XRateLimitReset' Retry-After: $ref: '#/components/headers/RetryAfter' content: application/json: schema: $ref: '#/components/schemas/Error' headers: XRequestId: description: | Unique id for this request. Echo this in your support tickets and we can trace the exact call in the audit log on the API key detail page. schema: type: string XAPIVersion: description: | Date-versioned schema marker. The current value is `2026-05-04`. Bumps follow the 12-month deprecation policy documented in the in-dashboard docs page. schema: type: string XRateLimitLimit: description: Total requests permitted per minute for this credential. schema: type: integer XRateLimitRemaining: description: Requests left in the current 60s window. schema: type: integer XRateLimitReset: description: Unix-seconds timestamp when the current window refills. schema: type: integer RetryAfter: description: | Seconds to wait before retrying. Only emitted on 429 responses. schema: type: integer securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: pk_live_… / pk_test_… or perk_at_… ```` ## Related topics - [Perkstar developer platform](/index.md) - [Send push notifications](/guides/wallet-pushes.md) - [Authentication and scopes](/fundamentals/authentication.md) - [TypeScript SDK](/sdks/typescript.md) - [Test mode](/fundamentals/test-mode.md)