Skip to main content
GET
/
pms
/
wallets
/
{wallet_id}
/
balance
Wallet Balance
curl --request GET \
  --url https://api.payvessel.com/pms/wallets/{wallet_id}/balance \
  --header 'api-key: <api-key>'
{
  "status": "<string>",
  "message": "<string>",
  "data": {
    "wallet_id": "<string>",
    "balance": "<string>",
    "currency": "<string>",
    "available_balance": "<string>"
  }
}
Retrieve the current balance for a managed wallet. Always verify the available balance before initiating transfers to avoid transaction failures.

​
Quick test (cURL)

​
Production

curl -X GET "https://api.payvessel.com/pms/wallets/wallet_123/balance" \
  -H "api-key: YOUR_API_KEY"

​
Sandbox

curl -X GET "https://sandbox.payvessel.com/pms/wallets/wallet_123/balance" \
  -H "api-key: YOUR_SANDBOX_API_KEY"

​
Endpoint

GET /pms/wallets/{wallet_id}/balance

​
Path Parameters

​
wallet_id
string
required
The unique identifier of the wallet.

​
Headers

NameTypeRequiredDescription
api-keystringRequiredYour API key

​
Response

​
status
string
Request status - "success" or "error".
​
message
string
Description of the result.
​
data
object

​
Example Request

curl -X GET https://api.payvessel.com/pms/wallets/WLT_123456/balance \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_SECRET"

​
Example Response

{
  "status": "success",
  "message": "Balance retrieved",
  "data": {
    "wallet_id": "WLT_123456",
    "balance": "500000",
    "available_balance": "495000",
    "currency": "NGN"
  }
}

Headers

​
api-key
string
required

Your Payvessel public API key

Path Parameters

​
wallet_id
string
required

The unique identifier of the wallet

Response

200 - application/json

Wallet balance retrieved successfully

​
status
string

Request status

​
message
string

Response message

​
data
object