Skip to main content

API platform overview

View as Markdown (opens in a new tab)

The API platform provides a shared framework for all APIs, using the same API keys, authentication methods, terminology, and error message formats.

This page lists the APIs by what they do: main APIs for payments and login, supporting APIs used alongside them, and reporting APIs for financial and sales data.

Not sure which API you need?

Start from your goal instead of the list below. On Find the right API you pick what you want to do — accept payments, let customers log in, or retrieve reporting data — and get the API and the product that go with it.

Main APIs​

ePayment API

Create and manage payment requests for online and in-person payments.

Recurring API

Create and manage agreements for subscription billing and recurring charges.

Login API

Confirm the identity of a customer and retrieve profile information through the login process.

Supporting APIs​

These APIs enhance your integration and are used alongside the main product APIs:

Access Token API

Required by all APIs. Obtain an access token to authorize API requests.

Webhooks API

Register for event notifications. Used with ePayment, Login, QR, Recurring, and Donations APIs.

QR API

Generate QR codes for payments and redirects. Also supports personal QR codes.

Userinfo API

Request user consent and retrieve profile information during a payment or agreement flow. Used with ePayment and Recurring APIs.

Order Management API

Enrich payments with order details visible in the app. Primarily for the legacy eCom API; ePayment includes basic order details by default.

Management and reporting APIs​

These APIs give accounting partners and merchants access to financial and sales data. See Reporting APIs for the full overview.

  • Management API - Manage sales units, retrieve merchant information, and prefill product orders on behalf of merchants.
  • Report API - Retrieve transaction and settlement data (funds, fees, payouts) for accounting and reconciliation.
  • Sales API - Retrieve order lines, VAT breakdowns, and sales context. For accounting partners.
  • Donations API - Retrieve donation records from the Donations product.

PSP solutions​

See Payment Service Provider solutions for the full list of PSP APIs, including signup, card passthrough, and legacy payment APIs.

Agentic commerce​

Legacy​

  • Test environment - Access the Merchant Test (MT) environment, download test apps, and understand testing limitations and capabilities.
  • API keys - Get your merchant API keys from the business portal for both test and production environments.
  • Authentication - Learn how authentication works and which method applies to your integration.
  • API servers - Find the correct server URLs for test and production environments across all APIs.

More topics to be found at: Integration and testing

Last updated on