---
title: "Get payment ledger"
method: GET
path: "/v1/customer/ledger"
tags: ["Customer"]
---

# Get payment ledger

`GET /v1/customer/ledger`

## Request

- Base URL: `https://app.getswipe.in/api/partner`
- URL: `https://app.getswipe.in/api/partner/v1/customer/ledger`
- Auth: HTTP bearer

**v1 is deprecated — use the v2 endpoint instead.** Returns a customer's payment ledger over a required date range — documents, payments, and the running balance.

## Query parameters

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

## Response `200`

Payment details fetched successfully

- PaymentGETResponse
  - `success` boolean: Success flag
  - `ledger` LedgerRecordV1[]
    - `serial_number` string: Serial Number
    - `total_amount` number: Total Amount
    - `amount_pending` number: Amount pending
    - `balance` number: Balance as of this record
    - `date` string: Payment Date
    - `mode` string: Payment Mode
    - `bank_details` BankDetails
      - `account_number` string, required: Account Number
      - `ifsc` string, required: IFSC Code
      - `bank_name` string, required: Bank Name
      - `branch` string, required: Branch
    - `created_time` string: Created Time of the Payment [YYYY-MM-DD HH:MM:SS] GMT
    - `notes` string: Notes
    - `status` string: Payment Status
  - `closing_balance` number: Closing Balance
  - `is_paid` boolean: Is Fully paid
  - `total_records` integer: Total Records available

## Other responses

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

## Changes

- **2026-11-03** `0bcdbc62187b`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/getswipe/apis/swipeapi/changes/v1/customer/ledger/get.md)

---

[API](https://skmtc.dev/getswipe/apis/swipeapi.md) - [All operations](https://skmtc.dev/getswipe/apis/swipeapi/llms.txt) - [OpenAPI document](https://skmtc.dev/getswipe/apis/swipeapi/revisions/0bcdbc62187b?raw)
