Piggyvest Business

Introduction

API Doc

Webhooks

Pay With Pocket

DocsFetch multiple wallets
Ctrl K

Fetch Multiple Wallets

GET/api/v1/wallet/:wallet_type

Fetches multiple wallets of a type.

Path Parameters

NameTypeRequiredDescription
wallet_typestringYes"api" (for API wallets).

Query Parameters

NameTypeRequiredDescription
limitintegerNoNumber of results (default: 20, max: 100).
cursorstringNoPagination cursor.
orderBystringNo"ASC" or "DESC" (default: DESC).
customer_idstringNoFilter by customer ID.
1
Request Example
(cURL)
curl -X GET "https://api.piggyvest.business/api/v1/wallet/api?limit=20" \\
-H "Authorization: Bearer YOUR_SECRET_KEY"
2
Success Response(200)
(JSON)
{
  "status": true,
  "message": "API wallets fetched successfully",
  "data": {
    "total_balance": 40000,
    "paginatedPayload": {
      "edges": [
        // Wallet objects...
      ],
      "pageInfo": {
        "hasNextPage": false,
        "endCursor": "2024-01-30T07:40:49.000Z"
      }
    }
  }
}
3
Error Response(400)
(JSON)
{
  "status": false,
  "message": "An error occurred fetching api wallets"
}