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 Get Merchant Funds endpoint returns the available fund balances for a merchant, with one entry per payment method. Use this endpoint to check how much of each cryptocurrency is available before initiating a withdrawal or collect operation. GET /merchants/{merchantID}/funds

​
Authentication

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

​
Path parameters

​
merchantID
string
required
The UUID of the merchant whose funds you want to retrieve.

​
Response fields

The endpoint returns an array of fund balance objects, one per payment method.
​
paymentMethodID
integer
required
The identifier for the payment method (cryptocurrency).
​
balance
string
required
The available balance as a decimal string (e.g., "250.00000000").
​
symbol
string
required
The token symbol for this payment method (e.g., "USDT", "ETH", "BTC").

​
Example request

curl --request GET \
  --url https://api.iterapay.com/merchants/b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f/funds \
  --header 'Authorization: Bearer <token>'

​
Example response

[
  {
    "paymentMethodID": 1,
    "balance": "250.00000000",
    "symbol": "USDT"
  },
  {
    "paymentMethodID": 2,
    "balance": "0.04150000",
    "symbol": "ETH"
  },
  {
    "paymentMethodID": 3,
    "balance": "0.00000000",
    "symbol": "BTC"
  }
]
Payment methods with a zero balance are included in the response. All supported payment methods for the merchant are always returned.

​
Error responses

StatusDescription
401Missing or invalid credentials.
403Valid credentials but insufficient permissions.
404No merchant found with the given merchantID.