v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB

Wallets

Get Customer Wallets

Use when resolving wallets by external customer id or lookup key (e.g. from your app's user id). Supports optional real-time balance and expand.

get/customers/wallets

Query parameters

-integer

populated from x-max-live header, not query param

expandstring

from_cacheboolean

idstring

include_real_time_balanceboolean

lookup_keystring

Response

alert_state'ok' | 'info' | 'warning' | 'in_alarm'

balancestring

conversion_ratestring

amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits

created_atstring date-time

created_bystring

credit_balancestring

currencystring

customer_idstring

descriptionstring

environment_idstring

idstring

metadataTypesMetadata

namestring

real_time_balancestring

real_time_credit_balancestring

status'published' | 'deleted' | 'archived'

tenant_idstring

topup_conversion_ratestring

topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits

updated_atstring date-time

updated_bystring

wallet_status'active' | 'frozen' | 'closed'

wallet_type'PRE_PAID' | 'POST_PAID'