Path parameters
string
required
The UUID of the merchant account to list invoices for.
Query parameters
string[]
Filter results by invoice type. Accepted values:
onetime, reusable, collect, withdraw.string[]
Filter results by invoice state (e.g.,
pending, paid, expired).string[]
Filter by token or payment method identifier.
string
Return only invoices with an amount greater than or equal to this value.
string
Return only invoices with an amount less than or equal to this value.
string
Return only invoices created on or after this ISO 8601 datetime (e.g.,
2024-01-01T00:00:00Z).string
Return only invoices created on or before this ISO 8601 datetime.
string[]
Filter collect-type invoices by their collection state.
boolean
default:"false"
When
true, includes archived invoices in the results.boolean
Filter by AML (Anti-Money Laundering) check status. Pass
true to return only invoices that have passed AML checks.string
Full-text search string to match against invoice descriptions or references.
number
default:"20"
Maximum number of invoices to return per page.
number
default:"1"
Page number for pagination.
string
default:"desc"
Sort direction. Accepted values:
asc, desc.string
Field to sort results by (e.g.,
createdAt, amount).Response
Returns a paginated list of invoice objects.object[]
Array of invoice objects.
number
Total number of invoices matching the applied filters.
number
The current page number.
number
The number of results returned per page.