Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.iterapay.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Use this endpoint to retrieve invoices associated with a merchant account. The response is paginated and supports a wide range of filters to narrow results by invoice type, state, payment token, amount range, or date range.

​
Path parameters

​
merchantID
string
required
The UUID of the merchant account to list invoices for.

​
Query parameters

​
types[]
string[]
Filter results by invoice type. Accepted values: onetime, reusable, collect, withdraw.
​
states[]
string[]
Filter results by invoice state (e.g., pending, paid, expired).
​
tokens[]
string[]
Filter by token or payment method identifier.
​
amountFrom
string
Return only invoices with an amount greater than or equal to this value.
​
amountTo
string
Return only invoices with an amount less than or equal to this value.
​
dateFrom
string
Return only invoices created on or after this ISO 8601 datetime (e.g., 2024-01-01T00:00:00Z).
​
dateTo
string
Return only invoices created on or before this ISO 8601 datetime.
​
collectStates[]
string[]
Filter collect-type invoices by their collection state.
​
showArchived
boolean
default:"false"
When true, includes archived invoices in the results.
​
amlOk
boolean
Filter by AML (Anti-Money Laundering) check status. Pass true to return only invoices that have passed AML checks.
​
search
string
Full-text search string to match against invoice descriptions or references.
​
limit
number
default:"20"
Maximum number of invoices to return per page.
​
page
number
default:"1"
Page number for pagination.
​
order
string
default:"desc"
Sort direction. Accepted values: asc, desc.
​
orderBy
string
Field to sort results by (e.g., createdAt, amount).

​
Response

Returns a paginated list of invoice objects.
​
data
object[]
Array of invoice objects.
​
total
number
Total number of invoices matching the applied filters.
​
page
number
The current page number.
​
limit
number
The number of results returned per page.
curl --request GET \
  --url 'https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/invoices?types[]=onetime&states[]=pending&limit=20&page=1&order=desc' \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f",
      "amount": "100.00",
      "type": "onetime",
      "state": "pending",
      "createdAt": "2024-01-15T10:30:00Z",
      "paymentMethodID": 1,
      "amlOk": true
    }
  ],
  "total": 1,
  "page": 1,
  "limit": 20
}