Stop Payment

Get stop payments by optional query parameters

get/stop-payments

Request

Base URL
https://sandbox.api.caas.reap.global
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.

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

merchantIdstring

Merchant/card acceptor ID (exact match).

mccstring

Merchant category code (exact match).

merchantNamestring

Merchant name (partial, case-insensitive match).

pagenumber float

limitnumber float

Accept-Versionstring required

Specifies the API version to use for this request.

Get stop payments