Account Balance

This endpoint allows you to retrieve the details of all wallets associated with a user, including a list of currencies and their corresponding amounts.

GET https://api.oxapay.com/v1/general/account/balance

Authentication

You must include the General API Key in the request header to authenticate your access to the API.

Name	Type	Description
general_api_key*	string	Your General API Key for authentication and authorization.

Request Params

Name	Type	Description
currency	string	Specify a specific currency to get the balance for that currency. If not provided, the response will contain the balance for all available currencies.

200: OK

{
  "data": { 
      [key: string]: decimal // Represents dynamic keys (currency symbol) with decimal values.
   },
  "message": string, // A message containing additional information about the result of the request.
  "error": {
    "type": string,
    "key": string,
    "message": string
  } || {}, // An object that provides details about any errors that occurred.
  "status": integer, // The status of the request response. Typically provided as a numeric code (e.g., 200 for success or other codes for errors).
  "version": string // The version of the API being used.
}

Please note that a successful request will return status 200. In case of any issues or validation problems, refer to the corresponding error for further details.

API Request Sample Codes

cURL

curl -X GET https://api.oxapay.com/v1/general/account/balance \
  -H "general_api_key: YOUR_GENERAL_API_KEY" \
  -H "Content-Type: application/json" 

PHP

<?php

$url = 'https://api.oxapay.com/v1/general/account/balance';

$headers = [
    'Content-Type: application/json',
    'general_api_key: YOUR_GENERAL_API_KEY'
];

$options = array(
    'http' => array(
        'header'  => implode("\r\n", $headers),
        'method'  => 'GET'
    ),
);

$context  = stream_context_create($options);
$response = file_get_contents($url, false, $context);
if ($response === FALSE) {
    die('Error occurred');
}

$result = json_decode($response, true);
var_dump($result);

?>

Node.js

const axios = require('axios');

const url = 'https://api.oxapay.com/v1/general/account/balance';

const headers = {
  'general_api_key': `YOUR_GENERAL_API_KEY`,
  'Content-Type': 'application/json',
};

axios.get(url, { headers })
  .then((response) => {
    console.log(response.data);
  })
  .catch((error) => {
    console.error(error);
  });

Python

import requests

url = 'https://api.oxapay.com/v1/general/account/balance'

headers = {
    'general_api_key': 'YOUR_GENERAL_API_KEY',
    'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers)
result = response.json()
print(result)

Please make sure to replace YOUR_GENERAL_API_KEY in the code snippets with your actual General API key.

These example code snippets demonstrate how to request the "Account Balance" endpoint using different programming languages. You can customize the data parameters according to your specific requirements.

API Response Example

{
  "data": {
    "BNB": 0.0000000000,
    "DGB": 0.0000000000,
    "XMR": 0.0000000000,
    "BTC": 0.3502949200,
    "ETH": 0.0000000000,
    "USDC": 0.0000000000,
    "POL": 0.0000000000,
    "SOL": 0.0000000000,
    "NOT": 0.0000000000,
    "SHIB": 0.0000000000,
    "TRX": 0.0000000000,
    "USDT": 1074682.7139400000,
    "DOGS": 0.0000000000,
    "TON": 0.0000000000,
    "BCH": 0.0000000000,
    "DOGE": 0.0000000000,
    "LTC": 0.0000000000
  },
  "message": "Operation completed successfully!",
  "error": {},
  "status": 200,
  "version": "1.0.0"
}

The response example above is provided to help you understand the format and structure of the response. If you have any further questions or need assistance, please feel free to contact to your account manager.