Payment API
Follow the payment lifecycle: choose a method in Payments, track its result in Payment Tracking, and receive confirmations through Webhooks. PPR References explains reusable and fixed-amount references. Refunds covers refund reconciliation; terminal and access operations follow at the end of the navigation. New request examples use fictional values; replace them with your integration data.
Tags
Payments
Choose a method, create payments, and manage unused authorizations, with guidance before the request schema.
Payment Tracking
After creating a payment, retrieve its status, refresh it from the provider, or find payments using filters. All operations are scoped to the authenticated merchant.
PPR References
Create and manage PPR payment references.
Refunds
Reconcile refund records and their processing states. Refund status is separate from the original payment status.
Webhooks
Receive payment notifications at your merchant HTTPS endpoint. These are callbacks sent to your application, not requests you send to the gateway.
Terminal Operations
Open, close, and inspect GPO terminal status.
Authentication
Authenticate API requests with your merchant bearer token. See the authentication guide to obtain a token. The endpoints below manage which users can access a merchant account.
Security Schemes
bearerAuth
Bearer token (JWT)
http
ApiKeyAuth
API Key in header (x-api-key)
apiKey
Webhooks
pprReferencePaymentNotification
PPR reference payment notification
POST
qrCodePaymentNotification
QR Code payment notification
POST