---
title: "Get Captures List"
method: GET
path: "/api/v1/simulation/{paymentId}/card/capture"
tags: ["Simulations"]
---

# Get Captures List

`GET /api/v1/simulation/{paymentId}/card/capture`

## Request

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

Get a list of all the `Captures` for a given payment.

  The `Captures` are created as a result of the [Simulate Card Authorization](/api#tag/Simulations/operation/simulateCardAuthorization) endpoint.

  **This endpoint is available for Card Rails (Virtual Debit Cards) only**.

  Refer to [Merchant API](/docs/payments/merchant-api/#payment-authorization-and-capture-via-card-rails-virtual-debit-cards) Guide for more information.

## Path parameters

- `paymentId` string, uuid, required: Payment ID

## Query parameters

- `filter[method]` string: Filter the list of objects by the value of the method field.
- `filter[success]` string
- `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: Comma-separated list of resources to include. Supported resources: `payments`

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

- CardCapturesRequestsResponse
  - `data` CardCapture[], required
    - `id` string, uuid, required: Unique identifier for the object.
    - `type` 'Capture', required
    - `attributes` object, required
      - `id` string, uuid, required: Capture ID
      - `amount` integer, required: The total amount of the payment captured, represented in the smallest currency unit (e.g., cents for USD). To obtain the value in dollars, divide by 100.
      - `success` boolean, required: Indicates whether the capture was successful.
      - `method` 'BankRails' | 'VirtualDebitCard', required: The payment method used to capture the payment.
      - `reference` string, nullable: Reference to the data inside an external system.
      - `updatedAt` string, date-time, required
      - `createdAt` string, date-time, required

## Other responses

- `404`: Not Found

---

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