Get Wallet Balance

Get your business wallet balance.

Retrieves the current balance of your business wallet for a specific cryptocurrency.

Endpoint

GET /v1/wallets/:currency/balance

Authentication

Business JWT only. This route is guarded by JWTHTTPAuthGuard; an API key will be rejected.

Header	Value
Authorization	Bearer <jwt>

Path parameters

Parameter	Type	Description
currency	string	Cryptocurrency code (e.g., USDT, USDC)

Example request

cURL

curl -X GET https://ramp-api.ivorypay.io/api/v1/wallets/USDT/balance \
  -H "Authorization: Bearer your_jwt_token"

Node.js

const response = await fetch("https://ramp-api.ivorypay.io/api/v1/wallets/USDT/balance", {
  method: "GET",
  headers: {
    "Authorization": "Bearer your_jwt_token",
  },
});

const data = await response.json();
console.log(data);

Python

import requests

response = requests.get(
    "https://ramp-api.ivorypay.io/api/v1/wallets/USDT/balance",
    headers={
        "Authorization": "Bearer your_jwt_token",
    },
)

print(response.json())

Go

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://ramp-api.ivorypay.io/api/v1/wallets/USDT/balance", nil)
	req.Header.Set("Authorization", "Bearer your_jwt_token")

	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

Example response

{
  "success": true,
  "message": "Query successful",
  "data": {
    "balance": 1250.75,
    "withdrawableBalance": 1200.25,
    "wallet": {
      "id": "f4e3d2c1-b0a9-8877-6655-44332211aabb",
      "businessId": "1c2b3a4d-5e6f-7081-9203-abcdef012345",
      "currency": "USDT",
      "balance": 1250.75,
      "context": "LIVE",
      "createdAt": "2026-01-10T09:00:00.000Z",
      "updatedAt": "2026-03-26T12:00:00.000Z"
    }
  }
}

Response fields

Field	Type	Description
balance	number	Total wallet balance for the currency
withdrawableBalance	number	balance minus the sum of expectedAmount across in-flight (ongoing) transactions, rounded to 8 decimal places
wallet	object	The full wallet entity for the requested currency (created on demand if it did not already exist)