Skip to main content
GET
/
pms
/
api
/
external
/
request
/
wallet
/
balance
Wallet Balance
curl --request GET \
  --url https://api.payvessel.com/pms/api/external/request/wallet/balance/ \
  --header 'api-key: <api-key>' \
  --header 'api-secret: <api-secret>'
{
  "status": true,
  "message": "<string>",
  "data": {
    "available_balance": "<string>",
    "ledger_balance": "<string>",
    "currency": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.payvessel.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve the current balance for a managed wallet. Always verify the available balance before initiating transfers to avoid transaction failures.

​
Endpoint

GET /pms/api/external/request/wallet/balance/

​
Headers

NameTypeRequiredDescription
api-keystringRequiredYour API key
api-secretstringRequiredYour API secret

​
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/api/external/request/wallet/balance/ \
  -H "api-key: YOUR_API_KEY" \
  -H "api-secret: YOUR_SECRET"

​
Example Response

{
  "status": true,
  "message": "string",
  "data": {
    "available_balance": "1.78",
    "ledger_balance": "-9390113420548.59",
    "currency": "NGN"
  }
}

Headers

​
api-key
string
required

Your Payvessel public API key

​
api-secret
string
required

Your Payvessel secret

Response

200 - application/json

Wallet balance retrieved successfully

​
status
boolean

Request status

​
message
string

Response message

​
data
object