---
title: "GET /api/v1/PaymentsStatusApi"
method: GET
path: "/api/v1/PaymentsStatusApi"
tags: ["PaymentsStatusApi"]
---

# GET /api/v1/PaymentsStatusApi

`GET /api/v1/PaymentsStatusApi`

## Query parameters

- `request.claimNumber` string
- `request.paymentId` integer
- `request.originalCheckNumber` string

## Response `200`

Retrieved Payments

- CcpDocsWcfPaymentStatusApiResponse
  - `DocumentList` CcpDocsWcfPaymentStatusApiResponseDocumentInfo[]
    - `DocId` string
    - `OriginalCheckNumber` string
    - `Check` CcpDocsWcfPaymentStatusApiResponseDocumentInfoCheckInfo
      - `PayeeName` string
      - `OriginalCheckNumber` string
      - `OriginalCheckAmount` number, double
    - `ClaimNumbers` string[]
    - `PayeeAddress` CcpDocsWcfPaymentStatusApiResponseDocumentInfoAddressInfo
      - `Name` string
      - `Address1` string
      - `Address2` string
      - `City` string
      - `State` string
      - `Zip` string
    - `Payments` CcpDocsWcfPaymentStatusApiResponseDocumentInfoZPassPaymentModality[]
      - `PaymentId` integer
      - `PaidPaymentAmount` number, double
      - `PaymentIssueDate` string, date-time
      - `PaymentClearedDate` string, date-time
      - `PaymentMethod` string
      - `PaymentStatus` string
      - `PaymentTransactions` CcpDocsWcfPaymentStatusApiResponseDocumentInfoZPassPaymentTransaction[]
        - `ChargeAmount` number, double
        - `Date` string, date-time
  - `ResultsTruncated` boolean

## Other responses

- `400` — Invalid request parameters
- `401` — Invalid credentials
- `403` — Invalid permissions
- `404` — Requested resource does not exist
- `500` — Unexpected error, contact Zelis

---

[API](https://skmtc.dev/redcard/apis/ccp-docs-wcf-public.md) · [All operations](https://skmtc.dev/redcard/apis/ccp-docs-wcf-public/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/redcard/ccp-docs-wcf-public/revisions/b572c437ad6b/schema)