---
title: "Get Wallet Balance"
method: GET
path: "/api/v1/wallets/:walletId/balance"
tags: ["Wallets"]
---

# Get Wallet Balance

`GET /api/v1/wallets/:walletId/balance`

## Request

- Base URL: `https://merchant-api.accruesavings.com`
- URL: `https://merchant-api.accruesavings.com/api/v1/wallets/:walletId/balance`
- Auth: none declared. Required headers: `Client-ID`, `Authorization`
- TypeScript: <https://skmtc.dev/byaccrue/apis/accrue-merchant-api/docs/api/v1/wallets/:walletId/balance/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `walletId` string: ID of the wallet for which the balance is being fetched.

## Query parameters

- `include` string: Comma-separated list of resources to include. Supported resources: `user`
- `userReference` string: Attached User Profile Reference ID
- `purchaseAmount` integer: Purchase amount in cents. When provided, conditional reward calculations may use this value (e.g. minimum purchase thresholds).
- `includeWithdrawableAmount` boolean: When true, the response includes the withdrawable amount in the balance.

## Headers

- `Client-ID` string, uuid, required: The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.
- `Authorization` string, uuid, required: Secure secret to access privileged endpoints.

## Response `200`

OK

- GetWalletBalanceResponse
  - `data` object, required: Balance of a Wallet
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Wallet', required
    - `attributes` object, required
      - `status` 'Active' | 'ClosingWithClosedLoop' | 'ManualReview' | 'Closed': The current status of the wallet.
      - `closedAt` string, date-time, nullable: The date and time when the wallet was closed.
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
      - `balance` object, required
        - `available` object, required: Funds available immediately.
          - `deposit` number, required: Funds deposited by the user.
          - `reward` object, required: Issued rewards.
            - `accrue` number, required
            - `merchant` number, required
            - `total` number, required
          - `total` number, required: Deposits and rewards combined.
        - `pending` object, required: Funds currently pending for funding transactions.
          - `deposit` number, required: Funds deposited by the user.
          - `reward` object, required: Issued rewards.
            - `accrue` number, required
            - `merchant` number, required
            - `total` number, required
          - `total` number, required: Deposits and rewards combined.
        - `reserved` object, required: Funds currently reserved for upcoming payment captures.
          - `total` number, required: Deposits and rewards combined.
        - `total` object, required: Total balance with all funds combined.
          - `deposit` number, required: Funds deposited by the user.
          - `reward` object, required: Issued rewards.
            - `accrue` number, required
            - `merchant` number, required
            - `total` number, required
          - `total` number, required: Deposits and rewards combined.
    - `relationships` object, required
      - `user` object
        - `data` object, required
          - `id` string, uuid, required
          - `type` 'User', required

## Other responses

- `400`: Bad Request
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/byaccrue/apis/accrue-merchant-api.md) - [All operations](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/llms.txt) - [OpenAPI document](https://skmtc.dev/byaccrue/apis/accrue-merchant-api/revisions/3e2d97ef2e6e?raw)