IP Whitelisting

This security feature limits access to a system or network exclusively to approved IP addresses. By rejecting requests from non-whitelisted IPs, it enhances protection against unauthorized access.

To Get Started:

Authorization	Set value to Bearer {{MERCHANT_AUTH_TOKEN}}
Content-type	Set value to application/json

To generate {{MERCHANT_AUTH_TOKEN}}; Log in to your account via the API.

Make a request to the URL below, where the base URL is determined by the environment you are on.

BaseUrl

Sandbox/PROD: https://api.startbutton.tech

Endpoint

PATCH {{baseUrl}}/merchant/ip-whitelist/configure

Add your IP(s) to be whitelisted just as in the sample request below.

Sample Request

{
    "whitelistedIps": ["127.0.0.1"],
    "password": "@mypassword"
}

Sample Response

{
    "success": true,
    "message": "Whitelisted IPs updated successfully",
    "data": {
                [ ]
            }
  {
        "whitelistedIps": [
            "127.0.0.1"
        ],
    }
}

NOTE: Once you whitelist your IP, the system validates the IP address in your request for all endpoints that require a PRIVATE/SECRET_KEY Authorization. If it's invalid, the request will Fail.

If a request is made with a non-whitelisted IP address you get the response below:

403 Error

{
    "message": "Access denied: IP not whitelisted",
    "success": false
}