GEgetswipe
Customer V2

Get payment ledger

Changed on

Returns a customer's payment ledger over a required date range — documents, payments, and the running balance.

get/v2/customer/ledger

Request

  • Base URL
    https://app.getswipe.in/api/partner
  • URL
    https://app.getswipe.in/api/partner/v2/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

messagestring

Response message

error_codestring

Error Code

errorsobject

Errors

Example response

{
  "success": true,
  "data": {
    "closing_balance": -16795.8,
    "is_paid": 1,
    "total_records": 10,
    "ledger": [
      {
        "balance": -16795.8,
        "created_time": "2024-06-13 10:08:13",
        "mode": "UPI",
        "date": "13-06-2024",
        "status": "Success",
        "serial_number": "PAYIN-2",
        "total_amount": 100
      }
    ]
  }
}

Changes