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

# Peach Payments Checkout API

Jentic publishes the only available OpenAPI specification for Peach Payments Checkout API, keeping it validated and agent-ready. Peach Payments Checkout API v2 provides payment processing for businesses operating in Africa. The API supports creating checkout sessions for both Embedded and Hosted Checkout integrations, querying checkout and payment statuses, and managing transactions. It handles multiple payment methods common in African markets including cards, mobile money, and bank transfers.

## For AI agents

Create checkout sessions, query payment status, and manage transactions for African payment processing. Supports Embedded and Hosted Checkout flows.

## Scope

Does not handle subscription billing, payouts, or multi-party marketplace payments - use for checkout session creation and payment status queries only.

## Capabilities

- Create checkout sessions for Embedded or Hosted Checkout integrations
- Query checkout session status and retrieve payment details
- Check individual payment transaction status by payment ID
- Process payments across multiple African payment methods
- Support card, mobile money, and bank transfer payment types

## Use cases

### E-Commerce Checkout for African Markets

Create checkout sessions for online stores serving customers across Africa. Peach Payments Checkout API v2 handles the checkout flow with support for local payment methods including cards, mobile money (M-Pesa, MTN Mobile Money), and bank transfers. Merchants can choose between Embedded Checkout (on-site) or Hosted Checkout (redirect) based on their integration preference.

Example prompt: POST to `/v2/checkout` with amount, currency (ZAR), and payment methods to create a checkout session for a South African transaction

### Payment Status Monitoring

Query the status of checkout sessions and individual payments to confirm successful transactions, detect failures, and trigger fulfillment workflows. The API provides separate endpoints for checkout-level and payment-level status, enabling granular monitoring of the payment lifecycle.

Example prompt: GET `/v2/checkout/{checkoutId}` to check session status, then GET `/v2/checkout/{checkoutId}/payment` to retrieve the associated payment details

### Transaction Reconciliation

Retrieve individual payment records by payment ID for financial reconciliation. Each payment record includes transaction amount, currency, status, and payment method used. This supports automated reconciliation between the payment gateway and merchant accounting systems.

Example prompt: GET `/v2/payments/{paymentId}` to retrieve the full payment record for reconciliation with the merchant accounting system

### AI Agent Payment Processing via Jentic

AI agents create checkout sessions and monitor payment status as part of automated commerce workflows by calling Peach Payments through Jentic. The agent searches for African payment operations, receives the schema, and executes without managing bearer tokens or understanding the Embedded vs Hosted Checkout distinction.

Example prompt: Search Jentic for 'create checkout session Africa', load the `/v2/checkout` operation schema, and execute with amount and currency to initiate a payment

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/v2/checkout` | Create a new checkout session |
| GET | `/v2/checkout/{checkoutId}` | Query checkout session status |
| GET | `/v2/checkout/{checkoutId}/payment` | Retrieve payment details for a checkout |
| GET | `/v2/payments/{paymentId}` | Query individual payment transaction status |

## Key resources

- **Checkout** — Create and query checkout sessions for Embedded or Hosted integrations
- **Payments** — Query individual payment transaction status and details

## Why Jentic

- **Setup:** Wiring Peach Payments Checkout by hand means setting up bearer auth, choosing between the testsecure and secure hosts for sandbox versus live, and threading checkout and payment ids through your calls yourself. Through Jentic you install once, import the Peach Payments Checkout API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Peach Payments puts the checkout and payment id in the URL path (`/v2/checkout/{checkoutId}`, `/v2/payments/{paymentId}`), so a rule can pin your agent to reading a specific checkout or payment. You choose the operations it may call, so creating a checkout session is included only if you add it and status reads can stand alone.
- **Credential handling:** Your Peach Payments bearer token 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 checkout session' or 'check a payment status', and Jentic returns the matching Peach Payments operation with its input schema for amount, currency, and payment method so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **NOWPayments API** — Cryptocurrency payment processing for global transactions
- **Braintree API** — Global payment processing with PayPal integration
- **Stripe API** — Comprehensive payment infrastructure with global coverage

## FAQ

### Why is there no official OpenAPI spec for Peach Payments Checkout API?

Peach Payments does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the Peach Payments Checkout API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Peach Payments Checkout API use?

Peach Payments Checkout API uses bearer token authentication. You pass your Peach Payments API key as a Bearer token in the Authorization header. Through Jentic, this key is stored encrypted in the vault and injected into requests automatically.

### What is the difference between Embedded and Hosted Checkout?

Embedded Checkout renders the payment form within your website using a JavaScript widget. Hosted Checkout redirects customers to a Peach Payments-hosted page for payment. Both are initiated via POST `/v2/checkout` but differ in how the checkout session is presented to the customer.

### Which payment methods does Peach Payments support?

Peach Payments supports cards (Visa, Mastercard), mobile money services common in African markets (M-Pesa, MTN Mobile Money), bank transfers, and other local payment methods. Available methods vary by country and merchant configuration.

### How do I check payment status through Jentic?

Install with pip install jentic, search for 'check payment status'. Jentic returns the `/v2/checkout/{checkoutId}` or `/v2/payments/{paymentId}` schemas. Execute to retrieve the current transaction status. Jentic handles bearer auth automatically.

### Which African countries does Peach Payments cover?

Peach Payments operates primarily in South Africa, Kenya, and Mauritius, with expanding coverage across the African continent. Supported currencies include ZAR, KES, and USD depending on the merchant configuration and country.

### Can I limit what my agent is allowed to do with the Peach Payments Checkout API?

Yes. Because you run Jentic One yourself, your own rules decide which Peach Payments operations the agent may call and which stored credentials it may use. You can allow only status reads such as GET `/v2/checkout/{checkoutId}` and GET `/v2/payments/{paymentId}` while leaving out POST `/v2/checkout`, so the agent can look up transactions without ever creating a checkout session. Since the checkout and payment IDs sit in the URL path, a rule can also pin the agent to reading a specific checkout or payment.