The IPWhitelistEntry object

Represents an IP address in the whitelist. IP whitelisting restricts API access to specific IP addresses for enhanced security.

Fields

Field	Type	Description
id REQUIRED	string	Unique identifier for the whitelist entry
merchantId REQUIRED	string	ID of the merchant this entry belongs to
ipAddress REQUIRED	string	Whitelisted IP address (IPv4 or IPv6)
description OPTIONAL	string	Description to identify this IP address
isActive REQUIRED	boolean	Whether this whitelist entry is active
createdBy REQUIRED	string	User ID who created this entry
createdAt REQUIRED	string	ISO 8601 timestamp when the entry was created

Example

{
  "id": "obj_1a2b3c",
  "merchantId": "merchant_1a2b3c",
  "ipAddress": "string",
  "description": "string",
  "isActive": false,
  "createdBy": "string",
  "createdAt": "2026-01-15T09:30:00Z"
}