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.

A merchant is the central account entity in IteraPay. Everything you do — creating invoices, receiving payments, managing team access, and withdrawing funds — happens within the context of a merchant account. Each merchant has a unique UUID that you supply in API paths to scope requests to your account.

​
Account structure

When you create a merchant account, IteraPay provisions:
  • A unique merchant ID (UUID) used in all API requests
  • Per-token balances tracking how much of each supported cryptocurrency you hold
  • A fee configuration defining what you pay for each operation type
  • Transaction limits setting the minimum amounts for collecting and withdrawing funds
  • A roles and permissions system for controlling team access

​
Balances

Your merchant account maintains a separate balance for each payment method (cryptocurrency) you accept. You can retrieve your current balances at any time: 
GET /merchants/{merchantID}/funds
The response lists each available payment method alongside its current balance. Balances reflect funds that have been received and settled — not funds that are pending confirmation on-chain.
Balances are denominated in the native token unit for each payment method. USD conversion uses the exchange rates configured in your account.

​
Fees

IteraPay charges fees based on the type of operation. You can inspect your fee structure at any time: 
GET /merchants/{merchantID}/fees
Applied when a customer pays a one-time invoice. Charged as a percentage or flat amount per transaction.
Applied to each payment collected through a reusable invoice. A reusable invoice can be paid multiple times, and the fee applies to each individual payment.
Applied when you sweep settled funds from an invoice into your main merchant balance.
Applied when you move funds from your merchant balance to an external on-chain address.

​
Transaction limits

IteraPay enforces minimum amounts for collect and withdrawal operations. These limits exist to keep on-chain transaction fees proportionate to the transfer value. Retrieve your limits with: 
GET /merchants/{merchantID}/limits
The response includes the minimum USD-equivalent amount you must collect or withdraw in a single operation. Attempts below the minimum will be rejected.
If a customer sends an amount below your configured minimum collect threshold, those funds cannot be swept until additional payments bring the total above the limit.

​
Roles and permissions (RBAC)

IteraPay uses role-based access control (RBAC) to let you grant team members the access they need without exposing your full account. Each role bundles a set of named permissions, and each member is assigned one or more roles.

​
Viewing roles and permissions

To see what roles exist on your merchant account and which permissions each role includes: 
GET /merchants/{merchantID}/roles
To check which permissions the currently authenticated user holds: 
GET /merchants/{merchantID}/permissions

​
Managing members

Members are the users who have access to your merchant account. You can list them with: 
GET /merchants/{merchantID}/members
The members list is paginated. Each entry includes the member’s identity and their assigned roles. For step-by-step instructions on inviting members and assigning roles, see the Team management guide.

​
Authentication

Most merchant endpoints accept either a Bearer token (JWT) or an API key. For server-to-server integrations, use an API key scoped to your merchant. See Authentication for setup details.

List merchants

Retrieve all merchant accounts accessible to your credentials.

Get merchant funds

Check current balances for each supported payment method.

Get merchant fees

Inspect the fee structure applied to your account.

Get merchant limits

View minimum collect and withdrawal amounts.