Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Wallets

Get wallet by ID

get/api/wallets/{id}

Path parameters

idstring required

Wallet ID

Response

Wallet details

idstring required
customerIdstring required
namestring
currencystring required
rateAmountstring required

1 credit = rateAmount in currency

creditsBalancestring required

Available credits

balancestring required

Monetary equivalent of credits

consumedCreditsstring required

Lifetime consumed credits

consumedAmountstring required

Lifetime consumed amount

status'ACTIVE' | 'TERMINATED' required
expirationAtstring
terminatedAtstring
metadataobject
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "customerId": "clxcust123",
  "name": "Main Wallet",
  "currency": "USD",
  "rateAmount": "1.0000",
  "creditsBalance": "100.0000",
  "balance": "100.0000",
  "consumedCredits": "50.0000",
  "consumedAmount": "50.0000",
  "status": "ACTIVE",
  "customer": {
    "id": "clx1234567890",
    "name": "Jane Doe",
    "email": "jane@example.com"
  }
}