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>'

import requests

url = "https://api.example.com/v1/wallet/credit"

headers = {
    "x-client-key": "<x-client-key>",
    "Authorization": "<authorization>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-key': '<x-client-key>', Authorization: '<authorization>'}
};

fetch('https://api.example.com/v1/wallet/credit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/wallet/credit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-client-key: <x-client-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/wallet/credit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-key", "<x-client-key>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/wallet/credit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-key"] = '<x-client-key>'
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "id": "098aeb90-e7f7-4f81-bc2e-4963330122c5",
  "balance": "150.50",
  "currency": "usdc",
  "isWithdrawable": true,
  "type": "CREDIT"
}

{
  "message": "Not authenticated"
}

{
  "message": "Not authorized"
}

{
  "message": "Internal server error"
}

GET

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>'

import requests

url = "https://api.example.com/v1/wallet/credit"

headers = {
    "x-client-key": "<x-client-key>",
    "Authorization": "<authorization>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'x-client-key': '<x-client-key>', Authorization: '<authorization>'}
};

fetch('https://api.example.com/v1/wallet/credit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/wallet/credit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "x-client-key: <x-client-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/wallet/credit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-client-key", "<x-client-key>")
	req.Header.Add("Authorization", "<authorization>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/wallet/credit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-client-key"] = '<x-client-key>'
request["Authorization"] = '<authorization>'

response = http.request(request)
puts response.read_body

{
  "id": "098aeb90-e7f7-4f81-bc2e-4963330122c5",
  "balance": "150.50",
  "currency": "usdc",
  "isWithdrawable": true,
  "type": "CREDIT"
}

{
  "message": "Not authenticated"
}

{
  "message": "Not authorized"
}

{
  "message": "Internal server error"
}

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

string

required

Your public API client key that identifies your environment

string

required

Bearer token obtained from OAuth flow or direct login

Query Parameters

boolean

default:false

Set to true to route request to US backend environment (if available for your client)

Response

string

Unique identifier for the credit wallet

string

Current balance in the wallet (decimal string for precision)

string

Currency code (e.g., “usdc”, “usdt”)

boolean

Whether funds can be withdrawn from this wallet

string

Wallet type identifier, always “CREDIT” for this endpoint

{
  "id": "098aeb90-e7f7-4f81-bc2e-4963330122c5",
  "balance": "150.50",
  "currency": "usdc",
  "isWithdrawable": true,
  "type": "CREDIT"
}

{
  "message": "Not authenticated"
}

{
  "message": "Not authorized"
}

{
  "message": "Internal server error"
}

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"

import requests

url = "https://dev.api.baanx.com/v1/wallet/credit"
headers = {
    "x-client-key": "YOUR_CLIENT_KEY",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.get(url, headers=headers)
credit_wallet = response.json()

print(f"Balance: {credit_wallet['balance']} {credit_wallet['currency']}")
print(f"Withdrawable: {credit_wallet['isWithdrawable']}")

const response = await fetch('https://dev.api.baanx.com/v1/wallet/credit', {
  method: 'GET',
  headers: {
    'x-client-key': 'YOUR_CLIENT_KEY',
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
});

const creditWallet = await response.json();
console.log(`Balance: ${creditWallet.balance} ${creditWallet.currency}`);

interface CreditWallet {
  id: string;
  balance: string;
  currency: string;
  isWithdrawable: boolean;
  type: 'CREDIT';
}

const response = await fetch('https://dev.api.baanx.com/v1/wallet/credit', {
  method: 'GET',
  headers: {
    'x-client-key': 'YOUR_CLIENT_KEY',
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
  }
});

const creditWallet: CreditWallet = await response.json();

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.

Withdraw from Credit Wallet - Initiate withdrawal to external wallet
Estimate Credit Withdrawal Fees - Calculate network fees before withdrawal
Get Wallet History - View transaction history for credit wallet

Overview

Authentication

User

Card

Orders

Wallet

Delegation

Consent

Referral

Webhooks

Get Credit Wallet Balance

Overview

Authentication

Query Parameters

Response

Code Examples

Important Notes

​Overview

​Authentication

​Query Parameters

​Response

​Code Examples

​Important Notes

​Related Endpoints

Overview

Authentication

Query Parameters

Response

Code Examples

Important Notes

Related Endpoints