Introduction

This API supports checking whether the user’s IP address is eligible for crypto buy and sell transactions.

If the isBuyAllowed and isSellAllowed flag are set to false, it means that users in the country where the IP address is located are not allowed to use the service.

API Description

Request Method: GET

Domain

Test environment:https://openapi-test.alchemypay.org/open/api/v4/merchant/ach/ip

Prod environment:https://openapi.alchemypay.org/open/api/v4/merchant/ach/ip

Request Parameters

Header Parameters:

Element	Mandatory	Data Type	Remarks
appid	Y	string	Partner unique ID, once a merchant has been on-boarded with Alchemy Pay, the merchant will be provided with the credentials with appId and appSecret
timestamp	Y	string	UTC time with 13 digit to represent time in milliseconds, expiration period is 5 minutes.
sign	Y	string	Signature, you can refer to the signature here

Url Parameter

Element	Mandatory	Data Type	Remarks
ipAddress	Y	string	The IP address

Response sample

{
    "success": true,
    "returnCode": "0000",
    "returnMsg": "SUCCESS",
    "extend": "",
    "data": {
        "country": "KR",
        "ipAddress": "141.164.36.113",
        "buyAllowed": true,
        "sellAllowed": true
    },
    "traceId": "64f1ca393edbe6119e9611f9123fa0ac"
}