PayAgency Logo
Payout

Wallet API

This document provides a comprehensive guide to the Get Wallet Details API. This endpoint allows businesses to retrieve wallet information associated with a user based on the provided secret key. The API returns wallet details such as wallet ID, currency, balance, status and payment method. The users will get wallet for payout service. The wallet would be profile specific.

API Endpoint

GET https://backend.pay.agency/api/v1/wallet

Headers

Header NameDescription
Content-TypeSpecifies the content type. Always set to application/json.
AuthorizationBearer token for authentication.

Example Responses

Success Response

{
  "data": [
    {
      "wallet_id": "WAL1234567890"
      "currency": "USD",
      "amount": 10000,
      "payment_method": "card",
      "status": "Active",
    },
    {
      "wallet_id": "WAL9876543210"
      "currency": "EUR",
      "amount": 5000,
      "payment_method": "card",
      "status": "Inactive",
    }
  ]
}

Error Response

{
  "message":"Authentication token is missing."
}  
{
  "message":"Invalid Secret Key."
}  

On this page