Skip to main content

GET /wallets/my-wallet

Use this read-only endpoint to fetch the wallet details of the currently authenticated user.

This endpoint is useful when your app needs to show a signed-in user's live wallet state (balance, available balance, credit limit, status) without needing admin-level access or a wallet ID lookup.

Endpoint​

GET /api/v1/wallets/my-wallet
Authorization: Bearer <ACCESS_TOKEN>

Access Rules​

  • Requires a valid Bearer token.
  • Returns the wallet for the user bound to the token.
  • Intended for non-admin business users (for example partner/vendor/merchant/sub-merchant users).
  • Read-only: no mutation is performed.

Request​

No query parameters or request body are required.

Success Response (200)​

{
  "id": "WALLET_X7f3Qm9nL2pRt6aV1kYz",
  "entityType": "MERCHANT",
  "entityId": "ENT_9aK2vP4mQ1xL8tD6rNw",
  "entityName": "Acme Retail Demo",
  "currency": "R",
  "balance": 124580.75,
  "creditLimit": 10000.00,
  "availableBalance": 134580.75,
  "lowBalanceThreshold": 3000.00,
  "status": "ACTIVE",
  "lastTransactionAt": "2026-10-01T14:22:11.518421",
  "createdDate": "2026-02-18T10:05:43.091237",
  "lastModifiedDate": "2026-10-01T14:22:11.527104",
  "hasNegativeBalance": false,
  "lowBalance": false
}

Notes for Integrators​

  • id and entityId are encoded identifiers and should be treated as opaque strings.
  • availableBalance may differ from balance depending on credit limit and wallet rules.
  • currency is currently returned as configured by the wallet service (for example R for ZAR display).

Common Error Responses​

  • 401 Unauthorized: Missing/invalid token.
  • 403 Forbidden: Authenticated user is not allowed to access this endpoint.
  • 404 Not Found or business error payload: No wallet mapped to the current user/entity.

Last updated: October 2026