Skip to main content
GET
/
pms
/
wallets
Get Wallets
curl --request GET \
  --url https://api.payvessel.com/pms/wallets \
  --header 'api-key: <api-key>'
{
  "status": "<string>",
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "balance": {
        "available_balance": "<string>",
        "ledger_balance": "<string>"
      },
      "currency": "<string>"
    }
  ]
}
Retrieve all managed wallets associated with your business. This is useful for monitoring balances across multiple wallets and reconciling transfers.

​
Quick test (cURL)

​
Production

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

​
Sandbox

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

​
Endpoint

GET /pms/wallets

​
Headers

NameTypeRequiredDescription
api-keystringRequiredYour API key

​
Response

​
status
string
Request status - "success" or "error".
​
data
array

​
Example Request

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

​
Example Response

{
  "status": "success",
  "data": [
    {
      "id": "WLT_1",
      "name": "Main Settlements",
      "balance": {
        "available_balance": "1000000.00",
        "ledger_balance": "1000000.00"
      },
      "currency": "NGN"
    },
    {
      "id": "WLT_2",
      "name": "Refunds Wallet",
      "balance": {
        "available_balance": "50000.00",
        "ledger_balance": "50000.00"
      },
      "currency": "NGN"
    }
  ]
}

Headers

​
api-key
string
required

Your Payvessel public API key

Response

200 - application/json

Wallets retrieved successfully

​
status
string

Request status

​
data
object[]