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.

The List Merchants endpoint returns all merchants associated with your credentials along with their current balances. Use this endpoint to display an overview of all your merchant accounts or to check balance positions across payment methods. GET /merchants

​
Authentication

Accepts a Bearer token (Authorization: Bearer <token>) or an API key (X-Api-Key: <key>).

​
Response fields

The endpoint returns an array of merchant objects.
​
id
string
required
The merchant’s unique identifier (UUID).
​
name
string
required
The merchant’s display name.
​
balances
object[]
required
A list of balance entries, one per payment method.

​
Example request

curl --request GET \
  --url https://api.iterapay.com/merchants \
  --header 'Authorization: Bearer <token>'

​
Example response

[
  {
    "id": "b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f",
    "name": "My Store",
    "balances": [
      {
        "paymentMethodID": 1,
        "balance": "250.00000000",
        "symbol": "USDT"
      },
      {
        "paymentMethodID": 2,
        "balance": "0.04150000",
        "symbol": "ETH"
      }
    ]
  },
  {
    "id": "e2d1a4f6-88bc-4a91-b3e7-1c9f20d84b52",
    "name": "Second Store",
    "balances": [
      {
        "paymentMethodID": 1,
        "balance": "0.00000000",
        "symbol": "USDT"
      }
    ]
  }
]

​
Error responses

StatusDescription
401Missing or invalid credentials.
403Valid credentials but insufficient permissions.