Retrieve a list of payments

This endpoint retrieves a paginated list of payments.

Query Parameters
skip integer — REQUIRED The number of records to skip for pagination. Example: 0
limit integer — REQUIRED The number of records to return for pagination. Example: 10
dateFrom string The start date for filtering payments (format: yyyy-mm-dd). Example: 2024-06-26
dateTo string The end date for filtering payments (format: yyyy-mm-dd). Example: 2024-07-04
reference string The unique reference for filtering payments. Example: ML008985
merchantAccountId string The merchant account ID for filtering payments. Example: DUKA INSTAGRAM
mode string The mode of payment (e.g., 'CHARGE', 'PAYOUT'). Example: CHARGE
status string The status of the payment (e.g., 'SUCCESSFUL', 'PROCESSING'). Example: SUCCESSFUL
fullName string The full name of the customer for filtering payments. Example: John Doe
skip integer — REQUIRED The number of records to skip for pagination.
limit integer — REQUIRED The number of records to return for pagination.

Header Parameters
apiToken string — REQUIRED Secret key for the project

Responses
200 Payments retrieved successfully Schema — OPTIONAL undefined
400 Bad request, such as invalid input Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
401 Unauthorized access Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.
500 Internal Server Error Schema — OPTIONAL code int32 Error code representing the type of error. message string Error message detailing what went wrong.