API platform overview
The API platform provides a shared framework for all APIs, using the same API keys, authentication methods, terminology, and error message formats. This makes it straightforward to integrate with multiple APIs.
Not sure which API you need?
- See Product mapping
Main APIs​
Recurring​
Let returning customers pay automatically.
- Recurring API - Create and manage agreements.
Checkout​
Sell more with an all-in-one online checkout.
- Checkout API - Create a checkout session that handles payments, shipping, and user information.
Using multiple APIs together
Many utility APIs like Webhooks, Userinfo, and Order Management can be used together with your main product integration without requiring separate product purchases.
Additional APIs​
Utility APIs​
Enhance your integration with these utility APIs, available with all main products:
- Access Token API - Obtain an access token to authorize all other API requests.
- Check-in API (experimental) - Communicate with your customer through the mobile app at the Point of Sale.
- Order Management API - Enrich your transactions by attaching images and information.
- QR API - Generate and administer QR codes that redirect the user to a URL.
- Userinfo API - Get the user's consent for access to their personal information.
- Webhooks API - Register for event notifications through webhooks.
Management and reporting APIs​
These APIs are helpful for managing your sales unit:
- Management API - Manage sales units, get information about merchants, or place orders on behalf of merchants.
- Report API - (For merchants and for accounting partners with accounting keys) Retrieve data about orders and settlements.
- Donations API - Use the Donations API to manage information related to donation market products and payments.
PSP APIs​
Payment Service Provider (PSP) APIs:
Legacy APIs​
- eCom API - (in maintenance mode)
SDKs​
- Deno SDK - (in maintenance mode)