Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Yoco Payments API

Read payment records (versioned Yoco API).

Yoco Payments API is one of 5 APIs that Yoco publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Payments. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 2026-07-12.

Requests are made against a single base URL, https://payments.yoco.com/api.

2 operations 2 paths 3 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2026-07-12
Base URL
https://payments.yoco.com/api
Authentication
HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Yoco Payments API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (secretKey). It accepts HTTP bearer tokens (JWT) (jwtBearer).

  • secretKey — Secret integration key passed as Authorization: Bearer sklive... (live) or Authorization: Bearer sktest... (test). Obtain keys in the Yoco app under Sales - Pa…
  • jwtBearer — JWT Bearer credential for the versioned Yoco API (api.yoco.com/v1), authorized with scopes such as business/orders:read.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Payments 2

Read payment records (versioned Yoco API).

GET
/v1/payments
List payments
listPayments 7 params → 200401
GET
/v1/payments/{paymentId}
Get a payment
getPayment 1 param → 200404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Payment (7 properties), Error (3 properties), PaymentList (2 properties). Each schema is shown below with its type and property counts.

Payment
object
7 properties
Error
object
3 properties
PaymentList
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yoco-payments-api-openapi.yml Raw ↑

Other APIs Yoco publishes across the network.

Yoco Checkout API
Yoco Payment Links API
Yoco Refunds API
Yoco Webhooks API