canonical: https://jentic.com/apis/checkout.com/checkout

# Checkout.com Payment Platform API

The Checkout.com Payment Platform API lets an agent accept and manage card payments end to end. It can tokenise card details, create and retrieve payments, capture, refund, and void a payment, list the actions taken on a payment, and create and manage customers. It is a payment processing service for online businesses.

## For AI agents

Accept and manage card payments through the Checkout.com Payment Platform API. Tokenise cards, create payments, capture, refund, and void them, and manage customers. Secured with a secret key sent as a bearer token, with OAuth2 for applicable flows.

## Scope

Does not handle payouts or dispute management - use it to accept, capture, refund, and void card payments and manage the customers behind them.

## Capabilities

- Tokenise card details
- Create and retrieve payments
- Capture, refund, and void a payment
- List the actions taken on a payment
- Create and manage customers

## Use cases

### Accept payments

Take card payments inside an agent workflow. The agent tokenises the card details and creates a payment, then reads it back to confirm the outcome.

Example prompt: Call POST /tokens, then POST /payments to charge the card

### Settle and reverse payments

Complete or unwind a charge after authorisation. The agent captures an authorised payment, refunds a settled one, or voids one that should not go through.

Example prompt: Call POST `/payments/{id}/captures`, /refunds, or /voids as needed

### Manage customers

Keep buyer records tied to payments. The agent creates customers and reads them back so repeat charges can reference a stored customer.

Example prompt: Call POST /customers to create a customer, GET `/customers/{id}` to read it

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/tokens` | Tokenise card details |
| POST | `/payments` | Create a payment |
| GET | `/payments/{id}` | Retrieve a payment |
| POST | `/payments/{id}/captures` | Capture an authorised payment |
| POST | `/payments/{id}/refunds` | Refund a payment |
| POST | `/payments/{id}/voids` | Void a payment |
| POST | `/customers` | Create a customer |
| GET | `/customers/{id}` | Retrieve a customer |

## Key resources

- **Payments** — Card payments and their captures, refunds, and voids
- **Customers** — Buyer records that payments can reference
- **Tokens** — Tokenised card details used to create payments

## AI readiness

This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.

- **Score:** 66 / 100
- **Maturity:** AI-Aware
- **Dimensions:**
  - Foundational Compliance: 99 / 100
  - Developer Experience & Jentic Compatibility: 61 / 100
  - AI-Readiness & Agent Experience: 46 / 100
  - Agent Usability: 94 / 100
  - Security: 68 / 100
  - AI Discoverability: 68 / 100
- **View full report:** https://jentic.com/apis/checkout.com/checkout/scorecard
- **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/
- **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview

### Score it yourself

Every API in the directory is allowlisted, so you can re-score it with no key required.

- **Score your own API:** https://jentic.com/scorecard.md
- **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md

```sh
npx @jentic/api-scorecard-cli score <openapi-url>
```

## Why Jentic

- **Setup:** Wiring the Checkout.com Payment Platform API by hand means managing a secret key, pointing at the api.checkout.com host, and shaping the payment requests yourself. Through Jentic you install once, import the Checkout.com Payment Platform API from the Jentic API Directory, store the key once, and your agent calls it.
- **Permission scoping:** You decide which operations your agent may call, so it can read payments without being able to refund or void them. Because the payment id sits in the URL path (`/payments/{id}`), a rule can pin the agent to a single payment rather than the whole account.
- **Credential handling:** Your Checkout.com secret key, sent as a bearer token, along with any OAuth2 credentials, is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'create a card payment' or 'refund a payment', and Jentic returns the matching operation with its input schema so the agent calls the right endpoint without reading the reference.

## Related APIs

- **Braintree** — Alternative card payment processing API
- **Mollie** — Alternative European payments API
- **GoCardless** — Complementary bank debit payments API

## FAQ

### What authentication does the Checkout.com Payment Platform API use?

It authenticates requests with a secret key sent as a bearer token, and supports OAuth2 for applicable flows. Through Jentic, those credentials are stored encrypted in your Jentic One instance and injected at execution time, so they never enter the agent context.

### What can an agent do with the Checkout.com Payment Platform API?

It can tokenise card details, create and retrieve payments, capture, refund, and void a payment, list the actions taken on a payment, and create and manage customers. The API is built for accepting card payments online.

### How does an agent connect to the Checkout.com Payment Platform API through Jentic?

Install Jentic One, import the Checkout.com Payment Platform API from the Jentic API Directory, and store the secret key once. Your agent then calls the operations you have allowed without handling the raw key.

### What are the rate limits for the Checkout.com Payment Platform API?

Rate limits are not specified in the OpenAPI spec. Check the Checkout.com documentation for current limits. Through Jentic, retries are handled in the execution layer.

### How many endpoints does the Checkout.com Payment Platform API have?

The Checkout.com Payment Platform API exposes 42 endpoints covering payments, customers, tokens, and related operations.

### Can I limit what my agent is allowed to do with the Checkout.com Payment Platform API?

Yes. Jentic One is self-hosted by you, so your own rules decide which operations your agent may call. You can let it read payments without being able to refund or void them, and because the payment id sits in the URL path, such as `/payments/{id}`, a rule can pin the agent to a single payment.