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.

These public endpoints return the payment details a customer needs to complete an invoice payment — specifically the deposit address, the exact amount to send, and when the payment window expires. No authentication is required, making these endpoints suitable for customer-facing checkout flows. Two variants are available: one to fetch the address for a single payment method, and one to retrieve addresses across all payment methods associated with the invoice.

​
Get address for a specific payment method

GET /public/invoices/{invoiceID}/method/{methodID}/address Returns the deposit address and payment details for a single payment method on an invoice.

​
Path parameters

​
invoiceID
string
required
The UUID of the invoice.
​
methodID
number
required
The integer ID of the payment method to retrieve an address for.

​
Response

​
address
string
required
The blockchain address the customer should send funds to.
​
amount
string
required
The exact amount the customer must send, expressed as a decimal string with up to 6 decimal places.
​
expiresAt
string
required
ISO 8601 timestamp indicating when the payment address expires. Payments received after this time may not be credited.

​
Get all addresses for an invoice

GET /public/invoices/{invoiceID}/addresses Returns an array of address objects across all payment methods configured for the invoice.
Although this endpoint is under the /public/ path, it requires authentication via Bearer token or API key.

​
Path parameters

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

​
Response

Returns an array of address objects, one per supported payment method.
​
data
object[]
Array of payment address objects.
curl --request GET \
  --url https://api.iterapay.com/public/invoices/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/method/1/address

{
  "address": "TRR8WbHdkLBqNJAXmjS5jT4xEtd7X9bWb",
  "amount": "100.500000",
  "expiresAt": "2024-01-15T12:00:00Z"
}