Wallet Balance

The Wallet Balance endpoint allows merchants to programmatically retrieve the current real-time balance of their FinovoPay account. This is essential for automated reconciliation, monitoring available funds for withdrawals, or displaying account status on internal merchant dashboards.

Endpoint Details

Base URL https://merchant.finovopay.com/v1/index.php
Method POST
Auth Bearer Token (Secret Key)

Request Parameters

Field Type Required Description
action String Yes Must be set to get_balance

Implementation Example

Sample Request Payload
{
  "action": "get_balance"
}
cURL Request
curl --request POST \
  --url https://merchant.finovopay.com/v1/index.php \
  --header 'Authorization: Bearer YOUR_SECRET_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "action": "get_balance"
  }'

Sample Response

{
  "success": true,
  "data": {
    "balance": 1250500.75
  }
}
success Boolean

Indicates if the balance was successfully retrieved.

data.balance Float

The current withdrawable balance in your merchant wallet.