API Reference
Advancehq.com

Export payments to CSV

post
https://api.advancehq.com/v1/payments/export

Exports payments to a CSV file, matching the export available in the Advance dashboard. Supports the same filters as the get all payments endpoint. The response is a text/csv attachment; each row is a payment with its amounts, fee breakdown, and lifecycle timestamps.

Query Params
boolean
Defaults to true

Include column headers in the CSV

integer
1 to 100000
Defaults to 10000

Maximum number of records to export

status
array of objects | null

Filter payments by status (can provide multiple)

Status
date-time | null

Start date for filtering payments

date-time | null

End date for filtering payments

payment_method
array of objects | null

Filter payments by payment method (can provide multiple)

Payment Method
Allowed:
string
enum

Field to sort by

Allowed:
string
enum
Defaults to desc

Sort order (asc or desc)

Allowed:
string | null

Search term to filter payments by merchant name or amount

Responses
200

Successful Response

Updated about 2 months ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 2 months ago

Did this page help you?