---
title: "Get stop payments by optional query parameters"
method: GET
path: "/stop-payments"
tags: ["Stop Payment"]
---

# Get stop payments by optional query parameters

`GET /stop-payments`

## Request

- Base URL: `https://sandbox.api.caas.reap.global`
- URL: `https://sandbox.api.caas.reap.global/stop-payments`
- Auth: API key in header `x-reap-api-key`
- TypeScript: <https://skmtc.dev/reap-global/apis/reap-api/docs/stop-payments/get.ts> (a function with typed inputs; its response is checked against the schema)

## Query parameters

- `cardId` string, uuid: Card ID. If not provided, result will include all stop instructions in all cards under your account.
- `status` 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'FAILED': Status of the stop instruction (Enum: PENDING, ACTIVE, EXPIRED, CANCELED, FAILED).
- `type` 'PAN' | 'Merchant' | 'MCC': Type of the stop instruction (Enum: PAN, Merchant, MCC)
- `merchantId` string: Merchant/card acceptor ID (exact match).
- `mcc` string: Merchant category code (exact match).
- `merchantName` string: Merchant name (partial, case-insensitive match).
- `page` number, float
- `limit` number, float

## Headers

- `Accept-Version` string, required: Specifies the API version to use for this request.

## Response `200`

Get stop payments

- object
  - `items` object[]
    - `id` string, required
    - `cardId` string, required
    - `businessUuid` string, required
    - `status` 'PENDING' | 'ACTIVE' | 'EXPIRED' | 'CANCELED' | 'FAILED' | 'UNKNOWN', required
    - `type` 'PAN' | 'Merchant' | 'MCC', required
    - `startDate` string, required
    - `endDate` string, required
    - `createdAt` string, required
    - `updatedAt` string, required
    - `canceledAt` string, nullable
    - `details` object, required
      - `duration` number, float, required
      - `cardAcceptorId` string, nullable
      - `merchantName` string, nullable
      - `mcc` string, nullable
      - `minAmount` number, float, nullable
      - `maxAmount` number, float, nullable
      - `lastExtensionDate` string, nullable
      - `lastExtensionDuration` number, float, nullable
  - `meta` object: Pagination metadata for the response.
    - `itemCount` number, float, required: The number of items returned on the current page.
    - `totalItems` number, float, required: The total number of items across all pages.
    - `itemsPerPage` number, float, required: The maximum number of items that can be returned per page.
    - `totalPages` number, float, required: The total number of pages available based on the **itemsPerPage** and **totalItems**.
    - `currentPage` number, float, required: The current page number in the paginated response.

## Other responses

- `400`: Invalid inputs
- `403`: Forbidden

## Changes

- **2026-11-03** `beb4b8d4eb01`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/reap-global/apis/reap-api/changes/stop-payments/get.md)

---

[API](https://skmtc.dev/reap-global/apis/reap-api.md) - [All operations](https://skmtc.dev/reap-global/apis/reap-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reap-global/apis/reap-api/revisions/beb4b8d4eb01?raw)