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

TabaPay Ledger API

This resource represents a Client's Ledger.

TabaPay Ledger API is one of 16 APIs that TabaPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://{FQDN}:{PORT}.

3 operations 2 paths 12 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.tabapay.com
Authentication
HTTP Bearer, API Key
License
All rights reserved
Resource Areas
1

Authentication & Security 2

TabaPay Ledger API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as Authorization (custom-header). By default, every request must be authenticated.

Paths & Operations 3

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

Ledger 3

This resource represents a Client's Ledger.

POST
/v2/clients/{ClientID}/ledgers
Create Ledger
createledger 1 param body → 200207
DELETE
/v2/clients/{ClientID}/ledgers/{LedgerID}
Delete Ledger
deleteledger 2 params → 200404
GET
/v2/clients/{ClientID}/ledgers/{LedgerID}
Retrieve Ledger
retrieveledger 3 params → 200404

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are retrieveLedgerResponse (14 properties), ledgerCreate (5 properties), createLedgerResponse (4 properties), apiResponseSCECEM (3 properties). Each schema is shown below with its type and property counts.

EM
string
Short description of the error if an error occurred.
apiResponseSCECEM
object
3 properties
EC
string
Internal Error Code. This is used to help TabaPay team members trace an error.
tpUserID
string
TabaPay user identifier
ledgerCreate
object
5 properties 5 required
createLedgerResponse
object
4 properties
tpISO4217Numeric
string
ISO-4217 numeric currency code
tpLedgerID
string
TabaPay ledger identifier
tpReferenceID
string
Client-defined reference identifier
apiResponseSCEC
object
2 properties
SC
integer
[HTTP Status Code](https://developers.tabapay.com/reference/http-status-codes/)
retrieveLedgerResponse
object
14 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

tabapay-ledger-api-openapi.yml Raw ↑

Other APIs TabaPay publishes across the network.

TabaPay 3D Secure API
TabaPay Account API
TabaPay Bank API
TabaPay Card API
TabaPay Client API
TabaPay FXRate API
TabaPay Health API
TabaPay Key API
TabaPay OFAC API
TabaPay SubClient API
TabaPay Tag API
TabaPay Transaction API