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 Limits endpoint returns the minimum amounts required for collect and withdrawal operations on a merchant account. Check these limits before initiating either operation to avoid rejected requests due to insufficient amounts. GET /merchants/{merchantID}/limits

Authentication

Requires a Bearer token (Authorization: Bearer <token>). API key authentication is not accepted for this endpoint.

Path parameters

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

Response fields

minCollect
string
required
The minimum amount required to initiate a collect operation, as a decimal string (e.g., "10.00").
minWithdraw
string
required
The minimum amount required to initiate a withdrawal, as a decimal string (e.g., "5.00").

Example request

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

Example response

{
  "minCollect": "10.00",
  "minWithdraw": "5.00"
}
Limits are set at the platform level and may vary depending on your merchant’s configured payment methods. Contact support if you need your limits reviewed.

Error responses

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