---
title: "Find Wallet Widget Data"
method: GET
path: "/api/v1/widgets/wallet"
tags: ["Widgets"]
---

# Find Wallet Widget Data

`GET /api/v1/widgets/wallet`

## Request

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

## Query parameters

- `includeDto` boolean: Include the Data Transfer Object field, containing widget data in a structured format.
- `purchaseAmount` integer: Purchase amount (in cents)
- `filter[userReference]` string: Merchant-scoped user identifier (`stableReferenceId`). Preferred for new integrations.
- `filter[secondaryUserReference]` string: Legacy `referenceId`. Provide alongside `filter[userReference]` when the stable id may not be on file yet.
- `filter[phoneNumber]` string: Filter the list of objects by the value of the phoneNumber field.

## 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

- GetWalletWidgetDataResponse
  - `data` WalletWidgetData, required: Widgets
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'WalletWidgetData', required
    - `attributes` object, required
      - `payload` string: Wallet Widget data encoded in base64.
      - `dto` object: Payload decoded into a structured format. The actual shape and content are dynamic and must be evaluated by the client for a particular use-case.
        - `dynamic` object, required
          - `value` number, required
    - `relationships` object, required
      - `wallet` object, required
        - `data` object, required
          - `id` string, uuid, required
          - `type` 'Wallet', required
    - `links` object, required
      - `self` string, required

## Other responses

- `400`: Bad Request

---

[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)