> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.yoco.com/docs/api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.yoco.com/_mcp/server. # Yoco API ## Docs - [Versioning](https://developer.yoco.com/docs/api/versioning.md) - [Security](https://developer.yoco.com/docs/api/security.md) - [Authentication](https://developer.yoco.com/docs/api/authentication.md) - [Applications](https://developer.yoco.com/docs/api/authentication/applications.md) - [Setting up your application](https://developer.yoco.com/docs/api/authentication/applications/setting-up-your-application.md) - [Scopes](https://developer.yoco.com/docs/api/authentication/scopes.md) - [API keys](https://developer.yoco.com/docs/api/authentication/api-keys.md) - [Managing API keys](https://developer.yoco.com/docs/api/authentication/api-keys/managing-api-keys.md) - [OAuth 2.0](https://developer.yoco.com/docs/api/authentication/oauth.md) - [Creating authorization URLs](https://developer.yoco.com/docs/api/authentication/oauth/creating-authorization-ur-ls.md) - [Managing authorization](https://developer.yoco.com/docs/api/authentication/oauth/managing-authorization.md) - [Obtaining tokens](https://developer.yoco.com/docs/api/authentication/oauth/obtaining-tokens.md) - [Refreshing access tokens](https://developer.yoco.com/docs/api/authentication/oauth/refreshing-access-tokens.md) - [Obtaining authenticated user info](https://developer.yoco.com/docs/api/authentication/oauth/obtaining-authenticated-user-info.md) - [Logging out users](https://developer.yoco.com/docs/api/authentication/oauth/logging-out-users.md) - [Using the REST API](https://developer.yoco.com/docs/api/using-the-rest-api.md) - [Error handling](https://developer.yoco.com/docs/api/error-handling.md) - [Pagination](https://developer.yoco.com/docs/api/pagination.md) - [Rate limiting](https://developer.yoco.com/docs/api/rate-limiting.md) - [Idempotency](https://developer.yoco.com/docs/api/idempotency.md) - [Webhooks](https://developer.yoco.com/docs/api/webhooks.md) - [Creating a subscription](https://developer.yoco.com/docs/api/webhooks/creating-a-subscription.md) - [Handling events](https://developer.yoco.com/docs/api/webhooks/handling-events.md) - [Verifying events](https://developer.yoco.com/docs/api/webhooks/verifying-events.md) - [Testing](https://developer.yoco.com/docs/api/webhooks/testing.md) - [Best practices](https://developer.yoco.com/docs/api/webhooks/best-practices.md) - [OpenAPI description](https://developer.yoco.com/docs/api/open-api-description.md) - [Conflict](https://developer.yoco.com/docs/api/error-codes/conflict.md) - [Content too large](https://developer.yoco.com/docs/api/error-codes/content-too-large.md) - [Forbidden](https://developer.yoco.com/docs/api/error-codes/forbidden.md) - [Method not allowed](https://developer.yoco.com/docs/api/error-codes/method-not-allowed.md) - [Missing required field](https://developer.yoco.com/docs/api/error-codes/missing-required-field.md) - [Not found](https://developer.yoco.com/docs/api/error-codes/not-found.md) - [Rate limited](https://developer.yoco.com/docs/api/error-codes/rate-limited.md) - [Server](https://developer.yoco.com/docs/api/error-codes/server.md) - [Service unavailable](https://developer.yoco.com/docs/api/error-codes/service-unavailable.md) - [Unauthorized](https://developer.yoco.com/docs/api/error-codes/unauthorized.md) - [Unsupported media type](https://developer.yoco.com/docs/api/error-codes/unsupported-media-type.md) - [Validation](https://developer.yoco.com/docs/api/error-codes/validation.md) > **Note:** This page contains both a page directory (above) and the landing page content (below). The page directory is generated for agent use and does not appear on the landing page. > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.yoco.com/docs/api/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.yoco.com/_mcp/server. # Yoco API The Yoco API enables developers to integrate directly with the platform via a Representational State Transfer (REST) API. ## What's an API? An API (application programming interface) is a set of definitions and protocols that allows for two systems to "talk" to each other. Using an online shop as a practical example, when you type your credit card details in and click pay, the online shop uses an API to talk to the payment gateway to process the transaction and ultimately deduct the money from your bank account. ## What's a REST API? A REST API is a set of rules and conventions for building and interacting with web services. * It uses the HTTP protocol. * It centres around resources - objects or things you can interact with, such as orders and payments. * It allows for a typical request/response interaction between a client and server. * It uses the standard HTTP methods for reading and writing data. * `GET`: Retrieve information about a resource. * `POST`: Create a new resource. * `PUT`: Update a resource. * `DELETE`: Remove a resource. * `PATCH`: Perform a partial update to a resource. * It's completely stateless. * It allows for information to be cached temporarily. * It allows for encrypted communication over HTTPS using Transport Layer Security (TLS). * It caters for authentication using an `Authorization` header.