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 the full details of a specific invoice. Two variants are available: an authenticated endpoint for merchant use, and a public endpoint that requires no authentication — useful for customer-facing invoice pages.

​
Authenticated endpoint

GET /merchants/{merchantID}/invoices/{invoiceID} Retrieve an invoice within the context of your merchant account.

​
Path parameters

​
merchantID
string
required
The UUID of the merchant account that owns the invoice.
​
invoiceID
string
required
The UUID of the invoice to retrieve.

​
Public endpoint

GET /public/invoices/{invoiceID} Retrieve an invoice without authentication. This is useful for building customer-facing payment pages where you need to display invoice details without exposing credentials.

​
Path parameters

​
invoiceID
string
required
The UUID of the invoice to retrieve.

​
Response

Both endpoints return the same invoice schema.
​
id
string
required
The UUID of the invoice.
​
amount
string
required
The invoice amount as a decimal string.
​
type
string
required
The invoice type: onetime, reusable, collect, or withdraw.
​
state
string
required
The current state of the invoice (e.g., pending, paid, expired).
​
createdAt
string
required
ISO 8601 timestamp of when the invoice was created.
​
paymentMethodID
number
required
The ID of the payment method associated with this invoice.
​
amlOk
boolean
Whether the invoice has passed AML (Anti-Money Laundering) checks.
curl --request GET \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/invoices/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f \
  --header 'Authorization: Bearer <token>'

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