---
title: "Collect Estimate/Invoice Payment"
method: POST
path: "/v2/customer_portal/payments/pay_amount"
---

# Collect Estimate/Invoice Payment

`POST /v2/customer_portal/payments/pay_amount`

## Request

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

collect payment done through card and update invoice/estimate status

## Request body

- object
  - `source` string
  - `payment_date` string
  - `payment_mode_uid` string
  - `receipt_email` string
  - `reference_no` string
  - `remarks` string
  - `send_receipt` boolean
  - `amount_paid` integer
  - `card_id` string
  - `invoice_status` string
  - `invoice_uid` string
  - `estimate_uid` string
  - `currency` string
  - `payment_transaction_uid` string
  - `charge_card` boolean
  - `card_on_file` boolean
  - `deposit` object
    - `total` integer
    - `collected` integer
    - `status` ''COLLECTED'' | ''NOT_COLLECTED''
    - `collected_at` string, date
    - `remarks` string

## Response `200`

200

- object
  - `type` string
  - `title` string
  - `message` string
  - `data` object
    - `invoice_uid` string
    - `paid_amount` number
    - `total_amount` number

## 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/pay_amount/post.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)