Skip to main content
GET
/
v1
/
wallet
/
credit
Get Credit Wallet Balance
curl --request GET \
  --url https://api.example.com/v1/wallet/credit \
  --header 'Authorization: <authorization>' \
  --header 'x-client-key: <x-client-key>'
{
  "id": "098aeb90-e7f7-4f81-bc2e-4963330122c5",
  "balance": "150.50",
  "currency": "usdc",
  "isWithdrawable": true,
  "type": "CREDIT"
}

​
Overview

Credit wallets hold funds available for spending through the Baanx platform. This endpoint retrieves the current balance, currency, and withdrawal status of the authenticated user’s credit wallet. Balance updates reflect purchases, refunds, and withdrawals in real-time. Use Cases:
  • Display user’s available credit balance in your application
  • Check if funds can be withdrawn before initiating withdrawal
  • Monitor credit wallet status for transaction processing
  • Verify sufficient balance before card operations

​
Authentication

​
x-client-key
string
required
Your public API client key that identifies your environment
​
Authorization
string
required
Bearer token obtained from OAuth flow or direct login

​
Query Parameters

​
x-us-env
boolean
default:false
Set to true to route request to US backend environment (if available for your client)

​
Response

​
id
string
Unique identifier for the credit wallet
​
balance
string
Current balance in the wallet (decimal string for precision)
​
currency
string
Currency code (e.g., “usdc”, “usdt”)
​
isWithdrawable
boolean
Whether funds can be withdrawn from this wallet
​
type
string
Wallet type identifier, always “CREDIT” for this endpoint
{
  "id": "098aeb90-e7f7-4f81-bc2e-4963330122c5",
  "balance": "150.50",
  "currency": "usdc",
  "isWithdrawable": true,
  "type": "CREDIT"
}

​
Code Examples

curl -X GET "https://dev.api.baanx.com/v1/wallet/credit" \
  -H "x-client-key: YOUR_CLIENT_KEY" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

​
Important Notes

Balance Precision: Balances are returned as strings to maintain precision for decimal values. Always parse as decimal types in your application, never as floating-point numbers.
Withdrawal Restrictions: The isWithdrawable flag indicates whether funds can be withdrawn. Some credit wallets may have restrictions based on user verification status, pending transactions, or platform policies.