Search payment
This endpoint searching and a paginated list of payments.
Query Parameters |
---|
skip integer — REQUIREDThe number of records to skip for pagination. Example: 0 |
limit integer — REQUIREDThe number of records to return for pagination. Example: 10 |
dateFrom stringThe start date for filtering payments (format: yyyy-mm-dd). Example: 2024-06-26 |
dateTo stringThe end date for filtering payments (format: yyyy-mm-dd). Example: 2024-07-04 |
reference stringThe unique reference for filtering payments. Example: ML008985 |
merchantAccountId stringThe merchant account ID for filtering payments. Example: DUKA INSTAGRAM |
mode stringThe mode of payment (e.g., 'CHARGE', 'PAYOUT'). Example: CHARGE |
status stringThe status of the payment (e.g., 'SUCCESSFUL', 'PROCESSING'). Example: SUCCESSFUL |
fullName stringThe full name of the customer for filtering payments. Example: John Doe |
Header Parameters |
---|
apiToken string — REQUIREDSecret key for the project |
Responses | |||
---|---|---|---|
200 Payments retrieved successfully
| |||
400 Bad request, such as invalid input
| |||
401 Unauthorized access
| |||
500 Internal Server Error
|