ZUzuper

Get Customer Payments

Changed on
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

pageinteger required
countinteger required
sortstring required

DESC, ASC

sort_bystring
timezonestring
filter.payment_status'"AWAIT_PAYMENT"' | '"SUCCESS"' | '"FAILED"'
filter.amount_frominteger
filter.amount_tointeger
filter.from_datestring date
filter.to_datestring date
filter.action_module'"JOB"' | '"CUSTOMER"' | '"ESTIMATE"' | '"INVOICE"' | '"SERVICE_CONTRACT"'
filter.action_uidstring
filter.estimate_uidstring
filter.invoice_uidstring

Response

200

typestring
current_page_recordsinteger
total_recordsinteger
current_pageinteger
total_pagesinteger

Example response

{
  "type": "success",
  "data": [
    {
      "payment_transaction_uid": "d364ffd1-8833-438a-addf-1eb31f3cdebe",
      "currency": "INR",
      "amount": 204,
      "payment_mode": {
        "payment_mode_uid": "a9120231-0bac-4dd4-8d50-e45526a8a933",
        "payment_mode_name": "Card",
        "payment_mode_type": "ONLINE"
      },
      "customer": {
        "customer_uid": "3b9a2a60-3d5f-11ed-a77f-7d639323b89a",
        "customer_first_name": "Ashin",
        "customer_last_name": "customer OG",
        "customer_email": "ashinthankachan1999@gmail.com",
        "customer_contact_no": {
          "mobile": "8301907278",
          "home": "123123",
          "work": "8301907278"
        },
        "is_active": true
      },
      "organization": {
        "organization_uid": "bd0a62d0-6cbc-11ee-83ad-4531910aaa26",
        "organization_name": "org17test2",
        "organization_email": "org17test2@mail.com",
        "no_of_customers": 4
      },
      "action_module": "INVOICE",
      "action_uid": "45449e82-aace-4785-b953-61064d0ca9e1",
      "status": "SUCCESS",
      "created_at": "2024-09-06T10:52:38.430Z",
      "updated_at": "2024-09-06T10:52:38.430Z"
    }
  ],
  "current_page_records": 1,
  "total_records": 73,
  "current_page": 1,
  "total_pages": 73
}

Changes