GEgetswipe
Customer

Get payment ledger

Changed on

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.

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

Query parameters

start_datestring required

Start date for the ledger, [DD-MM-YYYY]

end_datestring required

End date for the ledger, [DD-MM-YYYY]

customer_idstring required

Customer ID

num_recordsinteger

Number of records to fetch

pageinteger

Page number

Response

Payment details fetched successfully

successboolean

Success flag

closing_balancenumber

Closing Balance

is_paidboolean

Is Fully paid

total_recordsinteger

Total Records available

Example response

{
  "success": true,
  "ledger": [
    {
      "serial_number": "PAYIN-2",
      "total_amount": 100,
      "balance": -16795.8,
      "date": "13-06-2024",
      "mode": "UPI",
      "bank_details": {
        "account_number": "1234567890",
        "ifsc": "SBIN0000001",
        "bank_name": "State Bank of India",
        "branch": "Mumbai"
      },
      "created_time": "2024-06-13 10:08:13",
      "status": "Success"
    }
  ],
  "closing_balance": 100,
  "is_paid": true,
  "total_records": 10
}

Changes