v2

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

Top up or void credits

Add paid/granted credits or void existing credits from a wallet.

post/api/wallets/transactions

Request body

walletIdstring required
paidCreditsnumber

Paid credits to purchase

grantedCreditsnumber

Free credits to grant

voidedCreditsnumber

Credits to void

metadataobject

Example request

{
  "walletId": "wallet_id",
  "paidCredits": 100,
  "grantedCredits": 10,
  "voidedCredits": 25
}

Response

Transaction(s) created

Example response

{
  "transactions": [
    {
      "id": "clx1234567890",
      "walletId": "clxwallet123",
      "transactionType": "INBOUND",
      "status": "SETTLED",
      "transactionStatus": "PURCHASED",
      "creditAmount": "50.0000",
      "amount": "50.0000"
    }
  ],
  "wallet": {
    "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"
    }
  }
}