Skip to main content
The Get Merchant endpoint returns the details for a single merchant identified by its UUID. Use this endpoint to read merchant configuration, verify settings, or fetch metadata before performing operations on the merchant. GET /merchants/{merchantID}

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 to retrieve.

Response fields

id
string
required
The merchant’s unique identifier (UUID).
name
string
required
The merchant’s display name.
settings
object
Merchant-level configuration settings.

Example request

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

Example response

{
  "id": "b0fcc813-a7ce-4bbc-932f-dbef6f59ca7f",
  "name": "My Store",
  "settings": {
    "webhookUrl": "https://mystore.example.com/webhooks/iterapay",
    "ipWhitelist": ["203.0.113.42"]
  }
}

Error responses

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