Paymee Developer Documentation

How the integration works

Paymee uses a hosted checkout model. Your server creates a payment session, you redirect the buyer to the Paymee-hosted payment page, and we notify your server of the outcome with a signed webhook. Your servers never touch card data.

sequenceDiagram
    participant S as Your server
    participant P as Paymee
    participant B as Buyer
    S->>P: POST /gateway/sessions/
    P-->>S: { checkout_url }
    S->>B: redirect to checkout_url
    B->>P: buyer pays (3-D Secure)
    P->>S: webhook session.succeeded (X-Paymee-Signature)
    P->>B: redirect to return_url

Quickstart

Go from zero to a working payment in under 10 minutes with a single API call. Start here.

Hosted checkout

The full create-session → redirect → result lifecycle. Read the guide.

Webhooks

Receive payment and refund events and verify the X-Paymee-Signature. Set up webhooks.

API Reference

Every endpoint and webhook event, generated from our OpenAPI specification. Browse the reference.

Before you start

You need two credentials from your Paymee merchant dashboard — they are different and used in different places:

Credential	Looks like	Used for
Secret API key	sk_live_… / sk_test_…	Authenticating your API requests (Authorization header)
Webhook secret	whsec_…	Verifying the signature on incoming webhooks

Use the sk_test_… key in test mode while building, then swap to sk_live_… to go live.

Using these docs with AI

Building with an AI assistant? Every page has Copy for LLM and Download .md buttons under its title, and the whole site is available as plain Markdown for LLM context:

llms.txtIndex of every page, following the llms.txt convention.

llms-full.txtThe entire documentation concatenated into one Markdown file — paste it straight into an LLM.

OpenAPI specificationThe machine-readable spec (OpenAPI 3.1, YAML): generate a client, import it into Postman, or give it to your AI assistant.

Need help?

Write to support@paymee.tn.