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 Card account API

Card account associated to one of Yokoy's card programs. Only active card accounts are allowed to order new cards.

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

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

This API exposes 3 operations across 3 paths, and defines 3 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 3 paths 3 schemas 3 GET

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 Card account 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 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Card account 3

Card account associated to one of Yokoy's card programs. Only active card accounts are allowed to order new cards.

GET
/legal-entities/{legalEntityId}/card-accounts
List all card accounts
listCardAccounts 2 params → 200400401403429500502503
GET
/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}
Get card account by ID
getCardAccount 2 params → 200401403404429500502503
GET
/legal-entities/{legalEntityId}/card-accounts/{cardAccountId}/balance
Get card account balance
getBalance 2 params → 200401403404429500502503

Schemas 3

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

CardAccountBalance
object
3 properties 3 required
CardAccount
object
8 properties 5 required
Error
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yokoy-card-account-api-openapi.yml Raw ↑

Other APIs Yokoy publishes across the network.

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
Yokoy Invoice payment terms API