GET
/
v2
/
customer
/
ledger
curl --request GET \
  --url https://app.getswipe.in/api/partner/v2/customer/ledger \
  --header 'Authorization: <api-key>'
{
  "success": true,
  "message": "",
  "error_code": "",
  "errors": {},
  "data": {
    "closing_balance": -16795.8,
    "is_paid": 1,
    "total_records": 10,
    "ledger": [
      {
        "amount_pending": 0,
        "balance": -16795.8,
        "notes": "",
        "created_time": "2024-06-13T10:08:13.000Z",
        "mode": "UPI",
        "date": "13-06-2024",
        "status": "Success",
        "serial_number": "PAYIN-2",
        "total_amount": 100
      }
    ]
  }
}

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

message
string

Response message

Example:

""

error_code
string

Error Code

Example:

""

errors
object

Errors

data
object