Sign in

v2

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

Create a wallet

Create a prepaid credit wallet for a customer. Optionally seed it with paid or granted credits.

post/api/wallets

Request body

customerIdstring required
namestring
currencystring required
rateAmountnumber

1 credit = rateAmount in currency

paidCreditsnumber

Paid credits (purchase)

grantedCreditsnumber

Free credits (grant)

expirationAtstring

Expiration date (ISO 8601)

metadataobject
createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "customerId": "cust_abc123",
  "name": "Main Wallet",
  "currency": "USD",
  "rateAmount": 1,
  "paidCredits": 100,
  "grantedCredits": 10
}

Response

Wallet created

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"
  }
}