Introduction
This chapter covers basic features of API.
API key generation
The Payments AI Public API authenticates with an API key in the Authorization: ApiKey ... header (see Authentication). This page covers how to obtain that key, the temporal-to-permanent exchange that happens on production, and how to rotate the key over time.
Authentication
The Payments AI Public API authenticates every request with an API key passed in the Authorization header.
Base URLs and environments
Payments AI exposes two distinct APIs with different URL patterns and authentication conventions. Using the wrong pattern is a common source of integration errors.
Errors
In the course of interacting with Payments AI, you may encounter various error codes that indicate issues with your requests. These errors provide specific feedback about what went wrong so you can identify and resolve them quickly.
FramePay
8 items
Idempotency
Idempotency lets you safely retry a POST /transactions request without risking a duplicate charge. If a request times out or your connection drops before you receive a response, you can retry with the same idempotencyKey and Payments AI treats the retry as the same operation rather than a new one.
Subscriptions
Subscriptions-Cancellations
Test Cards
Below you could check test cards for validating the 3ds flow:
Tokenization
4 items
Webhooks
9 items