Skip to content
Paymee Developers

Overview

Paymee Merchant API 1.0.0

Section titled “Paymee Merchant API 1.0.0”

Server-to-server API for integrating the Paymee payment gateway.

Authenticate every request with your merchant secret API key in the Authorization header. The key prefix selects the mode on the same host: sk_test_... for test mode, sk_live_... for live mode.

Typical flow: create a payment session, redirect the buyer to the returned checkout_url, then track the outcome via webhooks and the session endpoints.

Errors use RFC 9457 problem details (application/problem+json).

Download this specification (OpenAPI 3.1, YAML) to generate a client or import it into Postman: merchant-api.yaml.

Webhooks are listed below the operations. Each delivery is a POST of the event as JSON, signed in the X-Paymee-Signature header (t=<timestamp>,v1=<hex>; two v1 values for 24 hours after a secret rotation), with the event id in X-Paymee-Webhook-Id and its name in X-Paymee-Event.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/gateway/sessions/
GET
/gateway/sessions/list/
GET
/gateway/sessions/{session_id}/
POST
/gateway/sessions/{session_id}/cancel/
POST
/gateway/sessions/{session_id}/refund/
GET
/gateway/sessions/{session_id}/webhooks/
GET
/gateway/webhooks/
POST
session.succeeded WEBHOOK
POST
session.attempt_failed WEBHOOK
POST
session.failed WEBHOOK
POST
session.expired WEBHOOK
POST
checkout.session.expired WEBHOOK
POST
refund.succeeded WEBHOOK
POST
refund.failed WEBHOOK

Authentication

Section titled “Authentication”

MerchantApiKey

Section titled “MerchantApiKey”

Authenticate with your merchant secret API key in the Authorization header:

Authorization: Bearer sk_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Use a sk_live_ key against production and a sk_test_ key against the sandbox. Keep secret keys server-side; never expose them in browser or mobile clients.

Security scheme type: http