Get Merchant — GET /merchants/{merchantID}

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

string

required

The UUID of the merchant to retrieve.

Response fields

string

required

The merchant’s unique identifier (UUID).

string

required

The merchant’s display name.

object

Merchant-level configuration settings.

Show properties

string

The URL IteraPay sends webhook events to for this merchant.

string[]

List of allowed IP addresses for API key requests.

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

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

Overview

Merchants

Invoices

Transactions & Withdrawals

Settings

Get Merchant — GET /merchants/{merchantID}

Authentication

Path parameters

Response fields

Example request

Example response

Error responses

​Authentication

​Path parameters

​Response fields

​Example request

​Example response

​Error responses

Authentication

Path parameters

Response fields

Example request

Example response

Error responses