GET
/
v1
/
customer
/
ledger
curl --request GET \
  --url https://app.getswipe.in/api/partner/v1/customer/ledger \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "ledger": [
    {
      "serial_number": "PAYIN-2",
      "total_amount": 100,
      "amount_pending": 0,
      "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-13T10:08:13.000Z",
      "notes": "",
      "status": "Success"
    }
  ],
  "closing_balance": 100,
  "is_paid": true,
  "total_records": 10
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

start_date
string
default:01-01-2024
required

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

end_date
string
default:31-12-2024
required

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

customer_id
string
required

Customer ID

num_records
integer
default:10

Number of records to fetch

page
integer
default:1

Page number

Response

200
application/json
Payment details fetched successfully
success
boolean

Success flag

Example:

true

ledger
object[]
closing_balance
number

Closing Balance

Example:

100

is_paid
boolean

Is Fully paid

Example:

true

total_records
integer

Total Records available

Example:

10