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

Yokoy Transaction API

A transaction is a cleared payment that is made using a credit, debit, or prepaid card. The card issuer can be either Yokoy or a third party that has been integrated with Yokoy.

Yokoy Transaction API is one of 22 APIs that Yokoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Transaction. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 3 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.0, at version 1.41.0.

Requests are made against 2 base URLs: https://api.yokoy.ai/v1/organizations/{organizationId}, https://api.test.yokoy.ai/v1/organizations/{organizationId}.

3 operations 2 paths 2 schemas 2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.41.0
Base URL
https://api.yokoy.ai/v1/organizations/{organizationId}
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Yokoy Transaction API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials flow.

  • OAuth2 — Authentication to the Yokoy API relies on the standard OAuth2 client credentials flow. 1. Obtain an access token Perform a POST request to https://accounts.yok…

Paths & Operations 3

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

Transaction 3

A transaction is a cleared payment that is made using a credit, debit, or prepaid card. The card issuer can be either Yokoy or a third party that has been integrated with Yokoy.

GET
/transactions
List all transactions
listTransactions 1 param → 200400401403429500502503
POST
/transactions
Create a card transaction
addTransaction 1 param body → 201400401409429
GET
/transactions/{transactionId}
Get transaction by ID
getTransaction 1 param → 200401403404429500502503

Schemas 2

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

Transaction
object
18 properties 6 required
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yokoy-transaction-api-openapi.yml Raw ↑

Other APIs Yokoy publishes across the network.

Yokoy Card account API
Yokoy Company card API
Yokoy Cost center API
Yokoy Daily statement API
Yokoy Expense API
Yokoy Expense category API
Yokoy External invoice API
Yokoy Finance export API
Yokoy FX rates API
Yokoy Goods receipt API
Yokoy Invoice API
Yokoy Invoice category API