Looking for ePay classic docs? Go to docs.epay.dk
ePay documentationDocsePay documentation

ePay Payments API

This API describes the endpoints for the ePay payments API. Communication is made using REST and standard web technologies.

API Explorer

Build requests from the OpenAPI spec, inspect the live cURL preview, and send test requests directly from the docs.

Sessions

Endpoints for payment session initialization.

Transactions

Endpoints for payment transactions (authorization, capture, refund, void, etc.).

Payouts

Endpoints for initiating payouts.

Settlements

Endpoints for settlement transfers and transactions.

Subscriptions

Endpoints for managing subscriptions.

Subscription Billing

Endpoints for managing automatic subscription billing.

Payment Links

Endpoints for creating payment links

Payment Methods

Endpoints for accessing payment method data

Webhooks

Endpoints for handling webhooks

Management

Endpoints for managing non-transaction resources

Partner

Endpoints for partner integrations

Schemas

Browse the individual component schemas used throughout the API.

Initialize Payment Session

Initializes a new payment session with the ePay Payments API. This endpoint requires a valid ApiKey and must be called from the server side to ensure the ApiKey is never exposed client-side. You’ll receive the outcome of the payment session on the notificationUrl you provide within the request, making it the primary way to track the result of this payment. Webhooks can be used separately if you need broader, system-wide updates. We recommend a minimum timeout of 5 seconds. Required or configurable fields In the ePay backoffice, under Advanced Point of Sale Settings, you can set default values for many session initialization parameters. This allows you to manage your setup without updating your code. Each property must be defined either in the backoffice or in the API request. If a value is provided in the API request, it overrides the backoffice default. The following fields can be configured: - scaMode - timeout - instantCapture - processor - maxAttempts - notificationUrl - successUrl - failureUrl - exemptions Note: Only a subset of these fields are strictly required for the API request. The table below indicates which fields are mandatory or optional.