---
title: "Get Customer Payments"
method: GET
path: "/v2/customer_portal/payments"
---

# Get Customer Payments

`GET /v2/customer_portal/payments`

## Request

- Base URL: `https://dc-region.zuperpro.com/api`
- URL: `https://dc-region.zuperpro.com/api/v2/customer_portal/payments`
- Auth: API key in header `x-api-key`

## Query parameters

- `page` integer, required
- `count` integer, required
- `sort` string, required
- `sort_by` string
- `timezone` string
- `filter.payment_status` '"AWAIT_PAYMENT"' | '"SUCCESS"' | '"FAILED"'
- `filter.amount_from` integer
- `filter.amount_to` integer
- `filter.from_date` string, date
- `filter.to_date` string, date
- `filter.action_module` '"JOB"' | '"CUSTOMER"' | '"ESTIMATE"' | '"INVOICE"' | '"SERVICE_CONTRACT"'
- `filter.action_uid` string
- `filter.estimate_uid` string
- `filter.invoice_uid` string

## Response `200`

200

- object
  - `type` string
  - `data` object[]
    - `payment_transaction_uid` string
    - `currency` string
    - `amount` integer
    - `payment_mode` object
      - `payment_mode_uid` string
      - `payment_mode_name` string
      - `payment_mode_type` string
    - `customer` object
      - `customer_uid` string
      - `customer_first_name` string
      - `customer_last_name` string
      - `customer_company_name` string
      - `customer_email` string
      - `customer_contact_no` object
        - `mobile` string
        - `home` string
        - `work` string
      - `is_active` boolean
      - `is_deleted` boolean
    - `organization` object
      - `organization_uid` string
      - `organization_name` string
      - `organization_email` string
      - `no_of_customers` integer
    - `action_module` string
    - `action_uid` string
    - `status` string
    - `created_at` string
    - `updated_at` string
  - `current_page_records` integer
  - `total_records` integer
  - `current_page` integer
  - `total_pages` integer

## Other responses

- `400`: 400

## Changes

- **2026-11-03** `3c21bc232e16`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/zuper/apis/zuper-pro-api/changes/v2/customer_portal/payments/get.md)

---

[API](https://skmtc.dev/zuper/apis/zuper-pro-api.md) - [All operations](https://skmtc.dev/zuper/apis/zuper-pro-api/llms.txt) - [OpenAPI document](https://skmtc.dev/zuper/apis/zuper-pro-api/revisions/3c21bc232e16?raw)