Skip to main content
GET
/
api
/
balance
curl https://api.swiftpay.cx/api/balance \
  -H "Authorization: Bearer mp_live_your_api_key"
const response = await fetch("https://api.swiftpay.cx/api/balance", {
   headers: {
      Authorization: "Bearer mp_live_your_api_key",
   },
});

const balance = await response.json();
console.log(balance.data.availableBalance);
import requests

response = requests.get(
    'https://api.swiftpay.cx/api/balance',
    headers={'Authorization': 'Bearer mp_live_your_api_key'}
)

balance = response.json()
print(balance['data']['availableBalance'])
{
  "success": true,
  "data": {
    "availableBalance": 150000,
    "reservedBalance": 25000,
    "totalBalance": 175000,
    "pendingWithdrawals": 0
  }
}
{
   "success": false,
   "error": {
      "type": "unauthorized",
      "message": "Invalid API key",
      "requestId": "req_abc123"
   }
}

Get Balance

Returns your current balance information including available balance, reserved amounts, and pending withdrawals.
Available balance = Total settled funds - Reserved balance - Pending withdrawals

Request

Authorization
string
required
Bearer token with your API key. Example: Bearer mp_live_your_api_key

Response

success
boolean
Whether the request was successful
data
object
curl https://api.swiftpay.cx/api/balance \
  -H "Authorization: Bearer mp_live_your_api_key"
const response = await fetch("https://api.swiftpay.cx/api/balance", {
   headers: {
      Authorization: "Bearer mp_live_your_api_key",
   },
});

const balance = await response.json();
console.log(balance.data.availableBalance);
import requests

response = requests.get(
    'https://api.swiftpay.cx/api/balance',
    headers={'Authorization': 'Bearer mp_live_your_api_key'}
)

balance = response.json()
print(balance['data']['availableBalance'])
{
  "success": true,
  "data": {
    "availableBalance": 150000,
    "reservedBalance": 25000,
    "totalBalance": 175000,
    "pendingWithdrawals": 0
  }
}
{
   "success": false,
   "error": {
      "type": "unauthorized",
      "message": "Invalid API key",
      "requestId": "req_abc123"
   }
}