Generate Settlements Report

GET

https://api.payos.money/v1/reports/settlements

Generates a report for settlements within a specified date range.

Query parameters

startDatestringRequired

Start date for the report in YYYY-MM-DD format.

endDatestringRequired

End date for the report in YYYY-MM-DD format.

statusenumOptional

Filter settlements by status.

Allowed values:

Response

Settlements report generated successfully.

Errors