Sign in

v1

latestOpenAPI 3.0.0All rights reserved2026-07-2439128156.3 KB
Ledger

Retrieve Ledger

Retrieves a ledger by ledgerID.

get/v2/clients/{ClientID}/ledgers/{LedgerID}

Path parameters

ClientIDstring required

22-character <glossary:ClientID>. Ask TabaPay Support if you need to specify a <glossary:SubClientID>.

LedgerIDstring required

22-character LedgerID returned from Create Ledger.

Query parameters

referenceIDstring

Reference ID fallback lookup.

Response

Ledger retrieved.

SCinteger

HTTP Status Code

ECstring

Internal Error Code. This is used to help TabaPay team members trace an error.

EMstring

Short description of the error if an error occurred.

ledgerIDstring

TabaPay ledger identifier

referenceIDstring

Client-defined reference identifier

userIDstring

TabaPay user identifier

bankstring
type'BalanceHolding' | 'Passthrough'
routingNumberstring
accountNumberstring
currencystring

ISO-4217 numeric currency code

createdstring date-time
updatedstring date-time

Example response

{
  "currency": "840"
}