---
title: "List of payments"
method: GET
path: "/v2/payment/list"
tags: ["Payment V2"]
---

# List of payments

`GET /v2/payment/list`

## Query parameters

- `start_date` string, required
- `end_date` string, required
- `status` string, required
- `num_records` integer
- `page` integer

## Response `200`

Payment details fetched successfully

- ListTransactions
  - `success` boolean — Success flag
  - `message` string — Response message
  - `error_code` string — Error code
  - `errors` object — Errors
  - `data` PaymentList
    - `transactions` PaymentTransactionModel[] — List of transactions
      - `total_amount` number — Amount of Payment
      - `amount_remaining` string — Remaining amount after the settlement
      - `bank_details` BankDetails
        - `account_number` string, required — Account Number
        - `ifsc` string, required — IFSC Code
        - `bank_name` string, required — Bank Name
        - `branch` string, required — Branch
      - `customer` Customer
        - `id` string, required — Unique id for each customer. If a new id is sent, a new Customer with the below details will be automatically created.
        - `name` string, required — Name of the Customer
        - `country_code` string — Customer Phone Number Country code
        - `phone_number` string — Customer Phone Number
        - `email` string — Customer Email
      - `payment_date` string — Payment date [DD-MM-YYYY]
      - `exclusive_notes` string — Internal notes for the payment
      - `linked_docs` LinkedDocs[] — List of documents linked to this payment
        - `amount_settled` number — Amount settled for the document, from the payment
        - `serial_number` string — Invoice number assigned to document
        - `document_type` string — Type of document
      - `notes` string — Notes for the document
      - `payment_mode` string — Payment mode of the recorded payment
      - `payment_type` string — Payment flow of the recorded payment
      - `status` string — Active status of the payment
      - `created_by` string — Document created by
    - `total_records` integer — Total number of records

## Other responses

- `400` — Error in fetching payment details
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.dev/getswipe/apis/swipeapi.md) · [All operations](https://skmtc.dev/getswipe/apis/swipeapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/getswipe/swipeapi/revisions/80fcaf1a3463/schema)