API Reference
Advancehq.com

Get all payments

get
https://api.advancehq.com/v1/payments

Retrieves a list of all payments, including payment status, amount, and timestamps.

Query Params
boolean
Defaults to false

Enable pagination with metadata

integer
≥ 1
Defaults to 1

Page number (1-based) - only used when pagination=true

integer
1 to 10000
Defaults to 100

Number of items per page - only used when pagination=true

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 | null

Filter payments by payment request ID

string | null

Filter payments by plan ID

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

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?