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

# Yoco Payments API

Yoco provides payments infrastructure for businesses in Africa. The API supports payment processing, payment links, orders, payouts, refunds, and webhooks. The API exposes 30 endpoints secured with bearer authentication.

## For AI agents

Programmatically oauth authorization endpoint, get oauth token. Covers 30 operations with bearer authentication.

## Scope

Does not handle communications, crm, or developer tools - use for payments only.

## Capabilities

- OAuth authorization endpoint
- Get OAuth token
- Logout
- List active capital advances
- Monitor Yoco Payments API operational status and events

## Use cases

### Payments Operations

Use the Yoco Payments API to perform payments operations programmatically. The API provides 30 endpoints covering core functionality including oauth authorization endpoint, get oauth token, get user info.

Example prompt: Call GET /authorize to oauth authorization endpoint

### Automated Capital Management

Automate capital operations by combining multiple Yoco Payments API endpoints. Agents can get oauth token and then get user info in a single workflow.

Example prompt: Call POST /token to get oauth token, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call Yoco Payments API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle bearer tokens manually.

Example prompt: Search Jentic for 'oauth authorization endpoint', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/authorize` | OAuth authorization endpoint |
| POST | `/token` | Get OAuth token |
| GET | `/userinfo` | Get user info |
| POST | `/logout` | Logout |
| GET | `/v1/capital/active-advances` | List active capital advances |
| GET | `/v1/capital/active-offers` | List active capital offers |
| GET | `/v1/locations` | List locations |
| GET | `/v1/oauth-2/token-info` | Get token info |

## Key resources

- **Capital** — Operations related to Capital
- **Checkout** — Operations related to Checkout
- **Locations** — Operations related to Locations
- **OAuth** — Operations related to OAuth
- **Orders** — Operations related to Orders

## 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:** 55 / 100
- **Maturity:** Foundational
- **Dimensions:**
  - Foundational Compliance: 82 / 100
  - Developer Experience & Jentic Compatibility: 63 / 100
  - AI-Readiness & Agent Experience: 51 / 100
  - Agent Usability: 94 / 100
  - Security: 60 / 100
  - AI Discoverability: 22 / 100
- **View full report:** https://jentic.com/apis/yoco.com/yoco/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 Yoco Payments by hand means running its OAuth token exchange against payments.yoco.com, carrying the bearer token on each call, and handling refresh and retries yourself. Through Jentic you install once, import Yoco Payments from the API Directory, store the credential once, and your agent calls it.
- **Permission scoping:** Yoco Payments exposes account-level reads and the token flow rather than a per-resource path handle here, so limit the agent to the operations it needs, such as listing locations or reading active capital offers. You choose that set, so it holds no capability beyond the operations you allow.
- **Credential handling:** Your Yoco Payments credential 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 'list locations' or 'check active capital advances', and Jentic returns the matching Yoco Payments operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Alternative payments API
- **Adyen** — Alternative payments API
- **Square** — Complementary payments API
- **Paypal** — Complementary payments API

## FAQ

### What authentication does the Yoco Payments API use?

The Yoco Payments API uses a Bearer token in the Authorization header. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I oauth authorization endpoint with the Yoco Payments API?

Yes. Use the GET /authorize endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the Yoco Payments API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I oauth authorization endpoint through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'oauth authorization endpoint'. Jentic returns the matching Yoco Payments API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the Yoco Payments API have?

The Yoco Payments API exposes 30 endpoints covering capital, checkout, locations operations.

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

Yes. Because Jentic One is self-hosted by you, your own rules decide which Yoco Payments operations and credentials the agent may use. Yoco Payments exposes account-level reads and the OAuth token flow rather than per-resource handles, so you can allow only the operations the agent needs, such as listing locations or reading active capital offers and advances, while withholding the rest. The agent holds no capability beyond the operations you permit.