GET /ipAddress/{merchantID} — Get IP address configuration

Use this endpoint to check which IP address is currently configured as the allowlisted address for a merchant’s API key authentication. If no restriction is set, only the address field will be present with a null value.

IP address restrictions apply to API key authentication only. Bearer token requests are not restricted by this setting.

This endpoint requires Bearer token authentication. API key authentication is not accepted.

Path parameters

string

required

The UUID of the merchant whose IP address configuration you want to retrieve.

Response

Returns a 200 OK with the IP address configuration on success.

string

The IPv4 address currently allowlisted for this merchant. Returns null if no IP restriction has been configured.

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

{
  "ipAddress": "203.0.113.42"
}

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

{
  "ipAddress": "203.0.113.42"
}

Overview

Merchants

Invoices

Transactions & Withdrawals

Settings

GET /ipAddress/{merchantID} — Get IP address configuration

Path parameters

Response

​Path parameters

​Response

Path parameters

Response