---
title: "List Payment Intents"
method: GET
path: "/api/v1/payment-intents"
tags: ["PaymentIntents"]
---

# List Payment Intents

`GET /api/v1/payment-intents`

## Request

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

## Query parameters

- `filter[initiator]` string: Filter the list of objects by the value of the initiator field.
- `filter[status]` string: Filter the list of objects by the value of the status field.
- `filter[paymentMethod]` string: Filter the list of objects by the value of the paymentMethod field.
- `page[limit]` number: Maximum number of objects that will be returned. Can not be greater than 50.
- `page[offset]` number: Offset from the beginning of the list of objects. Can not be negative.
- `sort` string: Sorts the list of objects by the given criteria. The sort parameter value is a comma separated list of sort criteria. Each sort criteria is a field name optionally followed by a minus sign (-) to indicate descending order. Ascending order is assumed if no minus sign is present. The sort criteria are applied in the order in which they appear in the sort parameter.
- `include` string, required: Comma-separated list of resources to include. Supported resources: `client`,`payments`,`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

- ListPaymentIntentsResponse
  - `data` object[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'PaymentIntent', required
    - `attributes` object, required
      - `balance` object: Optional wallet balance information
        - `available` integer, required: Available wallet balance in cents
        - `eligibleReward` integer, required: Eligible reward amount for this transaction in cents
        - `upperLimit` integer, required: Maximum checkout amount supported for this purchase, in cents
      - `billingAddress` object, nullable
        - `street` string, nullable, required
        - `street2` string, nullable, required
        - `city` string, nullable, required
        - `state` string, nullable, required
        - `postalCode` string, nullable, required
        - `country` string, nullable, required
      - `email` string, email, nullable
      - `error` 'LinkedAccountUnverified' | 'LinkedAccountDisconnected' | 'LinkedAccountMissing' | 'InsufficientBalance' | 'MissingFullName' | 'WrongEmail' | 'InvalidKycStatus', nullable: Specific error associated with the current invalid status.
      - `expiresAt` string, date-time, nullable: The datetime at which the payment intent is set to expire. After this time, the intent cannot be promoted to a payment and is considered expired.
      - `fullName` string, nullable
      - `phoneNumber` string, nullable
      - `amount` integer: Total purchase amount in cents.
      - `reference` string, nullable: Reference to the data inside an external system.
      - `status` 'Promotable' | 'PromotedToPayment' | 'Invalid' | 'Expired' | 'Canceled': The current status of the payment intent. Each status represents a different stage in the payment intent lifecycle, from creation to completion or cancellation.
      - `userId` string, nullable
      - `walletId` string, nullable: The ID of the wallet for which the payment intent is created.
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required
    - `relationships` object, required
      - `payments` object
        - `data` object[], required
          - `id` string, uuid, required
          - `type` 'Payment', required
  - `meta` object, required
    - `total` number, required
    - `limit` number, required
    - `offset` number, 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)