Skip to main content
GET
Get transaction metadata

Authorizations

API-KEY
string
header
required

Your partner API key.

Headers

Api-Version
string
default:2026-09.1
required

The API version this request targets. Required on every /api/v0/* call. Format YYYY-MM.<release>; 2026-09.1 is the latest. The version that served the request is echoed back on the response. Missing, malformed or unsupported values are rejected with 400.

Pattern: ^\d{4}-\d{2}\.\d+$

Path Parameters

userId
string
required

The customer — a cus_… reference id.

Example:

"cus_3HfG8kLp2QwE7rTy9UiO"

Response

The metadata. Unwrapped.

totalBalance
number

Sum of available balances on the customer's active fiat accounts.

totalBalanceError
string | null

Why the balance is incomplete: No accounts found, No eligible accounts found, Some account balances are not available.

totalBalanceCurrency
string

Currency of totalBalance.

lastTxAmount
number | null

Source amount of the latest transaction.

lastTxCurrency
string | null

Source currency of the latest transaction.

lastTxDate
string | null

Display date, D MMM, YYYY.

thisMonthDateRange
string

Display range, e.g. 1 Oct - 23 Oct.

txCountThisMonth
integer

Transactions created this calendar month (UTC).

pendingTxCount
integer

Reserved; currently always 0.

totalCurrentBalance
number

Reserved; currently always 0.

totalCurrentBalanceCurrency
string

Reserved.