Skip to content

Get All Charges

Request

Retrieve all charges with pagination

Query
pageinteger, >= 0

Page number (0-based)

Default:0
Example:page=0
limitinteger, >= 1

Number of charges per page

Default:20
Example:limit=20
merchant_idstring

Optional merchant ID to filter charges

Example:merchant_id=merchant_01j3sc1n1keghbg5q97gr1s08m
payment_typestring

Optional payment type to filter charges

Enum:"MANUAL""INVOICE""TERMINAL""SCAN_TO_PAY"
Example:payment_type=MANUAL
statusstring

Optional status to filter charges

Enum:"AUTHORIZED""SETTLED"
Example:status=SETTLED
charge_idstring

Optional charge ID to filter charges

Example:charge_id=ch_01j8emz8chfxbb2bqmtref8ch7
curl -i -X GET \
  'https://docs.taluspay.com/_mock/openapi/v1/charges?page=0&limit=20&merchant_id=merchant_01j3sc1n1keghbg5q97gr1s08m&payment_type=MANUAL&status=SETTLED&charge_id=ch_01j8emz8chfxbb2bqmtref8ch7'

Responses

Charges retrieved successfully

Bodyapplication/json
chargesArray of objects(Charge)required
totalinteger, (int64)required
totalPagesinteger, (int32)required
pageinteger, (int32)required
sizeinteger, (int32)required
Response
{
  "charges": [
    { … }
  ],
  "total": 0,
  "totalPages": 0,
  "page": 0,
  "size": 0
}