Skip to main content
GET
/
v1
/
settlements
/
balance
curl -X GET "https://olp-api.nipuntheekshana.com/v1/settlements/balance" \
  -H "Authorization: Bearer <your_jwt_token>"
{
  "availableBalance": 1250.75,
  "pendingBalance": 49.99,
  "totalEarned": 8340.20,
  "currency": "USD"
}

Authentication

This endpoint requires a Bearer token in the Authorization header.
Authorization: Bearer <your_jwt_token>

Response

availableBalance
number
The amount currently available for withdrawal. This reflects confirmed payments minus any pending or completed withdrawals.
pendingBalance
number
The amount from payments that are still being confirmed on-chain and not yet available for withdrawal.
totalEarned
number
The cumulative total amount earned across all confirmed payments.
currency
string
The currency of the balances (e.g., USD).
curl -X GET "https://olp-api.nipuntheekshana.com/v1/settlements/balance" \
  -H "Authorization: Bearer <your_jwt_token>"
{
  "availableBalance": 1250.75,
  "pendingBalance": 49.99,
  "totalEarned": 8340.20,
  "currency": "USD"
}