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 Payment Links API

Read shareable payment links (versioned Yoco API).

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

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

This API exposes 1 operation across 1 path, and defines 2 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.

1 operations 1 paths 2 schemas 1 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 Payment Links 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 1

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

Payment Links 1

Read shareable payment links (versioned Yoco API).

GET
/v1/payment_links/{paymentLinkId}
Fetch a payment link
getPaymentLink 1 param → 200404

Schemas 2

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

Error
object
3 properties
PaymentLink
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yoco-payment-links-api-openapi.yml Raw ↑

Other APIs Yoco publishes across the network.

Yoco Checkout API
Yoco Payments API
Yoco Refunds API
Yoco Webhooks API