GET
/
balance
Retrieve user's account balance
curl --request GET \
  --url https://staging-biz.coinprofile.co/v2/balance \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-User: <api-key>' \
  --header 'X-User-Version: <api-key>'
{
  "success": true,
  "message": "<string>",
  "data": {
    "balances": {
      "totalRecieved": 123,
      "totalSent": 123,
      "txnCount": 123,
      "toCurrency": "<string>",
      "amount": 123,
      "formattedAmount": 123
    }
  }
}

Authorizations

​
X-Api-User
string
header
required
​
X-Api-Key
string
header
required
​
X-User-Version
string
header
required

Query Parameters

​
currency
enum<string>

Currency for which balance is to be retrieved. When this is not supplied, balance will be retrieved for all available currencies.

Available options:
NGN,
USD,
USDT

Response

200 - application/json

successful operation

The response is of type object.