Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.papp.sa/llms.txt

Use this file to discover all available pages before exploring further.

What is Points ?

Points is a loyalty rewards platform that lets customers earn points from purchases and redeem available points during checkout.

How do customers earn points?

After a successful purchase, your system sends the completed order to Points. Points calculates and records the earned points for the customer.

How do customers redeem points?

When checkout redemption is enabled, your backend creates a Points checkout session and redirects the customer to complete the redemption flow.

Which integration should I use?

Use Matajer if your store is on Matajer. Use Earn-only if customers only need to earn points after purchases. Use Checkout flow if customers need to redeem points during checkout.

How do I activate Points on Matajer?

Open Matajer store settings, go to payment methods, choose Points under loyalty programs, then paste your Points activation keys. See Matajer for the step-by-step guide.

Which API keys do I need?

Use the Public Key to create checkout sessions. Use the Private Key for backend API requests through the x-api-key header. Never expose the Private Key in frontend code.

How do I know the order status?

Use webhooks as the main source of truth. Your backend can also call GET /v1/orders/{uuid} to check the latest status.

What should I store?

Store the Points order uuid, your own order_number, and the reference_number when available.

How do refunds work?

Use POST /v1/orders/{uuid}/refund. Points updates the order status and sends a refunded webhook.

What if my platform is not listed?

Use the direct API integration. Start with Quick start, then choose an Earning method or the full Checkout flow.

Who do I contact for support?

Contact support@papp.sa.