# Perkstar Developers > Build reliable loyalty, POS, CRM, and commerce integrations with the Perkstar API. - [Find your integration](https://developers.perkstar.co.uk/integrations/index.md): Choose a connection, check availability and follow the correct setup guide. - [Connect and verify safely](https://developers.perkstar.co.uk/integrations/connection-checklist.md): A short checklist for account ownership, access, the first result and recovery. - [Resend](https://developers.perkstar.co.uk/integrations/resend/index.md): Connect your own sending account, verify delivery and manage customer invitation emails. - [Connect your Resend account](https://developers.perkstar.co.uk/integrations/resend/setup.md): Set up a verified domain and activate email sending inside Perkstar's integrations workspace. - [Delivery reports and recovery](https://developers.perkstar.co.uk/integrations/resend/delivery-recovery.md): Understand email outcomes and recover a stopped or failed send without changing sending accounts silently. - [Klaviyo](https://developers.perkstar.co.uk/integrations/klaviyo/index.md): Connect loyalty profiles and events to Klaviyo and verify the correct account. - [Mailchimp](https://developers.perkstar.co.uk/integrations/mailchimp/index.md): Connect a Mailchimp audience and use consenting customers' loyalty data in segments and automations. - [Loyverse POS](https://developers.perkstar.co.uk/integrations/loyverse/index.md): Connect Perkstar to Loyverse for Wallet QR scanning, automatic points, exact balance redemption and matched refunds. - [Set up Loyverse](https://developers.perkstar.co.uk/integrations/loyverse/setup.md): Prepare a compatible Points card, set Loyverse earning to 0%, connect the businesses and test the complete journey. - [Move customers and send invitations](https://developers.perkstar.co.uk/integrations/loyverse/customer-migration-invitations.md): Copy existing Loyverse customers and points safely, choose whether to add welcome points, and invite each customer to install the right Wallet card. - [Use Loyverse at checkout](https://developers.perkstar.co.uk/integrations/loyverse/checkout.md): Show staff how to scan a customer's Wallet card, award points and redeem an exact balance through Loyverse POS. - [Refunds and troubleshooting](https://developers.perkstar.co.uk/integrations/loyverse/refunds-troubleshooting.md): Reconcile Loyverse refunds, diagnose delayed loyalty updates and disconnect the integration safely. - [Square](https://developers.perkstar.co.uk/integrations/square/index.md): Connect Square to Perkstar for customer-attributed earning, location-aware programme routing and matched refund corrections. - [Set up Square](https://developers.perkstar.co.uk/integrations/square/setup.md): Install the Square production beta, approve limited customer access, configure routing and enable optional Wallet-card identification. - [Earn with Square and redeem in Perkstar](https://developers.perkstar.co.uk/integrations/square/earning-redemption.md): Attach an existing Square Customer, award the routed Perkstar programme and understand the separate Perkstar redemption boundary. - [Square refunds and troubleshooting](https://developers.perkstar.co.uk/integrations/square/refunds-troubleshooting.md): Reconcile full and partial Square refunds, diagnose missing earning and disconnect the Square integration safely. - [SumUp POS Custom Loyalty](https://developers.perkstar.co.uk/integrations/sumup-pos/index.md): Connect a SumUp POS store, activate its gateway and verify loyalty at checkout. - [Shopify](https://developers.perkstar.co.uk/integrations/shopify/index.md): Connect the intended store and verify order, location and loyalty routing. - [Stripe Connect](https://developers.perkstar.co.uk/integrations/stripe/index.md): Connect the business payment account and check payout readiness. - [Acuity Scheduling](https://developers.perkstar.co.uk/integrations/acuity/index.md): Connect Acuity appointments to an existing Perkstar Stamp card for attendance earning and one-time online reward codes. - [Set up Acuity](https://developers.perkstar.co.uk/integrations/acuity/setup.md): Authorise the complete Acuity account, verify booking updates, link an existing Stamp card and test attendance and reward codes. - [Acuity appointments and rewards](https://developers.perkstar.co.uk/integrations/acuity/appointments-rewards.md): Understand customer matching, end-plus-15-minute attendance earning and one-time Acuity reward codes. - [Acuity cancellations and troubleshooting](https://developers.perkstar.co.uk/integrations/acuity/cancellations-troubleshooting.md): Correct cancellations and no-shows, diagnose missing attendance or reward codes and disconnect Acuity safely. - [Google Analytics 4](https://developers.perkstar.co.uk/integrations/ga4/index.md): Configure Google Analytics 4 measurement for supported customer journeys. - [Meta Pixel](https://developers.perkstar.co.uk/integrations/meta-pixel/index.md): Configure Meta Pixel measurement for supported customer journeys. - [TikTok Pixel](https://developers.perkstar.co.uk/integrations/tiktok-pixel/index.md): Configure TikTok Pixel measurement for supported customer journeys. - [Zapier](https://developers.perkstar.co.uk/integrations/zapier/index.md): Connect Perkstar to other business tools with instant loyalty triggers and safe, scoped actions. - [Connect Perkstar to Zapier](https://developers.perkstar.co.uk/integrations/zapier/setup.md): Open the public Perkstar app, authorise one business with OAuth, and test a safe first Zap. - [Triggers, actions, and searches](https://developers.perkstar.co.uk/integrations/zapier/triggers-actions.md): The exact operations in the public Perkstar app for Zapier, including event names and safety boundaries. - [Instant triggers and webhooks](https://developers.perkstar.co.uk/integrations/zapier/webhooks.md): Understand how Zapier subscribes to Perkstar events, handles retries, deduplicates deliveries, and manages hooks. - [Zapier recipes](https://developers.perkstar.co.uk/integrations/zapier/recipes.md): Build reliable Perkstar Zaps for customer onboarding, loyalty activity, operations, and consented messaging. - [Zapier troubleshooting](https://developers.perkstar.co.uk/integrations/zapier/troubleshooting.md): Diagnose public-app access, OAuth, instant triggers, actions, searches, rate limits, and consent failures. - [Zapier data and security](https://developers.perkstar.co.uk/integrations/zapier/data-security.md): Understand OAuth access, customer-data flow, consent, retention, deletion, and operational safeguards for Perkstar Zaps. - [Make](https://developers.perkstar.co.uk/integrations/make/index.md): Build visual Perkstar scenarios with one instant loyalty-event trigger, guided loyalty modules, searches, and secure OAuth. - [Connect Perkstar to Make](https://developers.perkstar.co.uk/integrations/make/setup.md): Get private-beta access, authorise Perkstar with OAuth, and test a controlled first Make scenario. - [Triggers, actions, and searches](https://developers.perkstar.co.uk/integrations/make/modules.md): The complete Perkstar module catalogue for Make, with inputs and safety boundaries. - [Webhooks and instant scenarios](https://developers.perkstar.co.uk/integrations/make/webhooks.md): Understand Make attached webhooks, server-attested delivery verification, retries, duplicate protection, and queues. - [Make scenario recipes](https://developers.perkstar.co.uk/integrations/make/recipes.md): Reliable Perkstar scenario patterns for onboarding, loyalty activity, operations, and consented Wallet messaging. - [Make troubleshooting](https://developers.perkstar.co.uk/integrations/make/troubleshooting.md): Diagnose private-beta access, OAuth, instant triggers, modules, queues, retries, rate limits, and consent failures. - [Make data and security](https://developers.perkstar.co.uk/integrations/make/data-security.md): Understand OAuth scopes, personal-data flow, consent, Make retention surfaces, and shared responsibilities. - [Google Calendar](https://developers.perkstar.co.uk/integrations/google-cal/index.md): Availability and next steps for Google Calendar. - [Lightspeed Restaurant K-Series](https://developers.perkstar.co.uk/integrations/lightspeed-k-series/index.md): Availability and next steps for Lightspeed Restaurant K-Series. - [Lightspeed Retail](https://developers.perkstar.co.uk/integrations/lightspeed/index.md): Availability and next steps for Lightspeed Retail. - [Setmore](https://developers.perkstar.co.uk/integrations/setmore/index.md): Availability and next steps for Setmore. - [Mindbody](https://developers.perkstar.co.uk/integrations/mindbody/index.md): Availability and next steps for Mindbody. - [Deliveroo](https://developers.perkstar.co.uk/integrations/deliveroo/index.md): Availability and next steps for Deliveroo. - [Dojo](https://developers.perkstar.co.uk/integrations/dojo/index.md): Availability and next steps for Dojo. - [Toast](https://developers.perkstar.co.uk/integrations/toast/index.md): Availability and next steps for Toast. - [Clover](https://developers.perkstar.co.uk/integrations/clover/index.md): Availability and next steps for Clover. - [Aloha Cloud (NCR Silver)](https://developers.perkstar.co.uk/integrations/aloha-cloud/index.md): Availability and next steps for Aloha Cloud (NCR Silver). - [EPOS Now](https://developers.perkstar.co.uk/integrations/epos-now/index.md): Availability and next steps for EPOS Now. - [GoDaddy Poynt](https://developers.perkstar.co.uk/integrations/poynt/index.md): Availability and next steps for GoDaddy Poynt. - [MX POS](https://developers.perkstar.co.uk/integrations/mx-pos/index.md): Availability and next steps for MX POS. - [PAX](https://developers.perkstar.co.uk/integrations/pax/index.md): Availability and next steps for PAX. - [Access EPoS](https://developers.perkstar.co.uk/integrations/access/index.md): Availability and next steps for Access EPoS. - [Sunmi](https://developers.perkstar.co.uk/integrations/sunmi/index.md): Availability and next steps for Sunmi. - [Perkstar developer platform](https://developers.perkstar.co.uk/index.md): Connect POS, CRM, commerce, and back-office systems to Perkstar loyalty. - [Your first safe POS test](https://developers.perkstar.co.uk/quickstart.md): Record one test stamp, prove retries do not duplicate it, and check a signed webhook receipt. - [Authentication and scopes](https://developers.perkstar.co.uk/fundamentals/authentication.md): Protect API credentials and grant only the permissions an integration needs. - [Security, privacy, and data handling](https://developers.perkstar.co.uk/fundamentals/security-privacy.md): Understand Perkstar's security boundaries, privacy roles, retention rules, and integration responsibilities. - [Test mode](https://developers.perkstar.co.uk/fundamentals/test-mode.md): Exercise an integration without changing live customer balances or configuration. - [Idempotency and retries](https://developers.perkstar.co.uk/fundamentals/idempotency.md): Retry requests without adding the same stamp, point award, or enrolment twice. - [Errors and request tracing](https://developers.perkstar.co.uk/fundamentals/errors.md): Handle Perkstar API failures consistently and give support enough detail to trace them. - [Pagination](https://developers.perkstar.co.uk/fundamentals/pagination.md): Traverse large customer, enrolment, transaction, card, and webhook collections safely. - [Build a POS integration](https://developers.perkstar.co.uk/guides/pos.md): Walk through a complete till journey: connect, identify, earn, display, reverse, and reconcile. - [Build an OAuth marketplace app](https://developers.perkstar.co.uk/guides/oauth-marketplace.md): Implement installation, consent, token rotation, revocation, and reconnect for a multi-merchant Perkstar integration. - [Connect Odoo](https://developers.perkstar.co.uk/guides/odoo.md): A production pattern for syncing Odoo contacts and POS orders with Perkstar. - [Synchronise customers](https://developers.perkstar.co.uk/guides/customer-sync.md): Match customer records without duplicates and preserve consent correctly. - [Receive webhooks](https://developers.perkstar.co.uk/guides/webhooks.md): Verify signed Perkstar events, handle retries, and reconcile missed deliveries. - [Webhook event catalogue](https://developers.perkstar.co.uk/reference/webhook-events.md): Every Perkstar outbound webhook event, with exact data fields and representative payloads. - [Send push notifications](https://developers.perkstar.co.uk/guides/wallet-pushes.md): Send a customer-safe wallet push or simulate delivery in test mode. - [Connect with MCP](https://developers.perkstar.co.uk/tools/mcp.md): Give compatible AI clients secure, read-only access to Perkstar business reporting through OAuth. - [API availability](https://developers.perkstar.co.uk/support/api-availability.md): See which Perkstar resources are stable public contracts and which workflows are not yet partner-ready. - [Run the API in Postman](https://developers.perkstar.co.uk/tools/postman.md): Import the official Perkstar collection and environment for repeatable, end-to-end API testing. - [API status](https://developers.perkstar.co.uk/support/status.md): Check live Perkstar API, dashboard, scanner, wallet, webhook, billing, and POS service health. - [Go-live checklist](https://developers.perkstar.co.uk/support/go-live-checklist.md): Verify security, correctness, and operational recovery before sending production traffic. - [Versioning and compatibility](https://developers.perkstar.co.uk/support/versioning.md): Understand Perkstar API versions, SDK releases, and safe upgrade practices. - [List customers](https://developers.perkstar.co.uk/api-reference/customers/list-customers.md) - [Create or upsert a customer](https://developers.perkstar.co.uk/api-reference/customers/create-or-upsert-a-customer.md): When `external_ref` is supplied, the endpoint upserts on the unique `(orgId, externalRef)` key: • Existing match → returns the existing record with HTTP 200. No fields are overwritten. • No match → creates a new customer, HTTP 201. - [Get a customer](https://developers.perkstar.co.uk/api-reference/customers/get-a-customer.md) - [Anonymize (GDPR Article 17 erasure) a customer](https://developers.perkstar.co.uk/api-reference/customers/anonymize-gdpr-article-17-erasure-a-customer.md) - [Update a customer](https://developers.perkstar.co.uk/api-reference/customers/update-a-customer.md) - [List enrollments](https://developers.perkstar.co.uk/api-reference/enrollments/list-enrollments.md) - [Create an enrollment](https://developers.perkstar.co.uk/api-reference/enrollments/create-an-enrollment.md) - [Get an enrollment](https://developers.perkstar.co.uk/api-reference/enrollments/get-an-enrollment.md) - [Update an enrollment](https://developers.perkstar.co.uk/api-reference/enrollments/update-an-enrollment.md) - [List transactions](https://developers.perkstar.co.uk/api-reference/transactions/list-transactions.md) - [Post a transaction (stamp / redeem / adjust)](https://developers.perkstar.co.uk/api-reference/transactions/post-a-transaction-stamp-redeem-adjust.md) - [Bulk-delete every test-mode transaction for the org](https://developers.perkstar.co.uk/api-reference/transactions/bulk-delete-every-test-mode-transaction-for-the-org.md): Sandbox cleanup. Requires a `pk_test_…` key — live keys are rejected with 403. Returns the row count deleted. Aggregates on Customer / Card / Enrollment do not need recomputing because test rows never contributed to them. - [List cards](https://developers.perkstar.co.uk/api-reference/cards/list-cards.md) - [Get a card](https://developers.perkstar.co.uk/api-reference/cards/get-a-card.md) - [List recent outbound events](https://developers.perkstar.co.uk/api-reference/webhooks/list-recent-outbound-events.md): Returns one canonical row per source event, newest first. REST-hook integrations use this endpoint to load representative sample data whose keys and types match the live webhook envelope. Live events are returned by default; request `mode=test` or `mode=all` explicitly when validating sandbox activi… - [List webhooks](https://developers.perkstar.co.uk/api-reference/webhooks/list-webhooks.md) - [Create a webhook](https://developers.perkstar.co.uk/api-reference/webhooks/create-a-webhook.md): Direct API-key requests use the normal 24-hour idempotency response cache. For OAuth REST-hook clients, the idempotency key remains bound to the live subscription until DELETE. A retry with the same event set returns that row; use PATCH to apply a current URL, card, mode, or active state. `client_hm… - [Get a webhook](https://developers.perkstar.co.uk/api-reference/webhooks/get-a-webhook.md) - [Delete a webhook](https://developers.perkstar.co.uk/api-reference/webhooks/delete-a-webhook.md) - [Update a webhook](https://developers.perkstar.co.uk/api-reference/webhooks/update-a-webhook.md) - [Verify a server-attested webhook delivery](https://developers.perkstar.co.uk/api-reference/webhooks/verify-a-server-attested-webhook-delivery.md): OAuth-only callback proof endpoint for approved automation connectors. It binds the parsed event and retention-bounded Perkstar delivery headers to the exact outbound attempt committed before dispatch. Authenticated proof failures deliberately return the same `{ "verified": false }` response so webh… - [List locations](https://developers.perkstar.co.uk/api-reference/locations/list-locations.md) - [Send a wallet push](https://developers.perkstar.co.uk/api-reference/pushes/send-a-wallet-push.md): 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`. - [Auth check + org context](https://developers.perkstar.co.uk/api-reference/marketplace/auth-check-+-org-context.md): Confirms the API key is valid + returns the operator's org context (name, currency, timezone) and the available cards. First call every POS adapter makes on install. - [Find-or-create customer + post transaction in one call](https://developers.perkstar.co.uk/api-reference/marketplace/find-or-create-customer-+-post-transaction-in-one-call.md): Resolves the customer in this fixed priority order: 1. customer_id → tenant-scoped Perkstar customer 2. card_serial → POS barcode or legacy pass serial → customer 3. external_ref → (orgId, externalRef) lookup 4. email (case-insensitive) 5. phone (normalised E.164 with a legacy raw-value fa… - [Find-or-create customer + enrolment (no transaction)](https://developers.perkstar.co.uk/api-reference/marketplace/find-or-create-customer-+-enrolment-no-transaction.md): Same identifier resolution + create-on-miss as `/marketplace/accrue`, but without posting a transaction. - [Reverse a previously-posted transaction](https://developers.perkstar.co.uk/api-reference/marketplace/reverse-a-previously-posted-transaction.md): Creates a compensating Transaction row whose `delta` is the negation of the original's, linked via `reverses_transaction_id`. Fires `TRANSACTION_CREATED` so partner webhooks notice the reversal end-to-end. - [Receive a perkstar outbound event](https://developers.perkstar.co.uk/api-reference/outbound-webhooks/receive-a-perkstar-outbound-event.md): Perkstar POSTs this signed envelope to each active endpoint subscribed to the event. Client-managed integrations verify `X-Perkstar-Signature` against the exact raw body. Approved OAuth connectors can instead use Perkstar's server-attested verification contract without receiving the signing secret.… - [TypeScript SDK](https://developers.perkstar.co.uk/sdks/typescript.md): Use the official typed Perkstar client with automatic retries, pagination, and webhook verification. - [Python SDK](https://developers.perkstar.co.uk/sdks/python.md): Use the official Perkstar Python client with retries, cursor pagination, typed errors, and webhook verification. - [Changelog](https://developers.perkstar.co.uk/changelog.md): Developer-facing changes to the Perkstar API, SDK, and integration guidance. ## OpenAPI Specs - [openapi](/api/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.