Find Wallet Widget Data

get/api/v1/widgets/wallet

Request

Base URL
https://merchant-api.accruesavings.com
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

includeDtoboolean

Include the Data Transfer Object field, containing widget data in a structured format.

purchaseAmountinteger

Purchase amount (in cents)

Example:1000

filter[userReference]string

Merchant-scoped user identifier (stableReferenceId). Preferred for new integrations.

Example:stable-abc-123

filter[secondaryUserReference]string

Legacy referenceId. Provide alongside filter[userReference] when the stable id may not be on file yet.

Example:user-123

filter[phoneNumber]string

Filter the list of objects by the value of the phoneNumber field.

Headers

Client-IDstring 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.

Example:123e4567-e89b-12d3-a456-426614174000

Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

Example response

{
  "data": {
    "attributes": {
      "payload": "YmFzZTY0IGVuY29kZWQgZGF0YQ==",
      "dto": {
        "dynamic": {
          "value": 1
        }
      }
    },
    "links": {
      "self": "https://merchant-api.accruesavings.com/api/v1/widgets/wallet/123e4567-e89b-12d3-a456-426614174000"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.