Get buyer's info by IP
The endpoint is used to obtain location information based on the IP address. Its purpose is to enable the system to adapt payment flows, currencies, local payment methods, and the interface display according to the user’s country.
Header parameters
Attribute
Requirement
Description
x-public-key
mandatory
a public key that identifies the merchant account (there can be several for one merchant)
x-buyer-ip
mandatory
is responsible for information about the buyer's IP address
x-date
mandatory
is responsible for the date and time of sending the request
x-token
mandatory
generated on the merchant side
x-source
mandatory
identifier of the type of service that is the initiator of the request
x-id
mandatory
service identifier from which the current request is made
Request parameters
Attribute
Type
Requirement
Description
Standard
ip
string
mandatory
Buyer's IP
IPv4 | IPv6
merchant
string
mandatory
Valid merchant name
-
Response parameters
Attribute
Type
Description
type
string
Source/type of the geo data
iso2Code
string
Two-letter country ISO code
recommendedCurrency
string
Recommended currency ISO code for the location
possibleVatPercent
integer
Possible VAT percentage for the country/region.
NOTE: Will be removed in future iterations
NOTE: Will be removed in future iterations
city
object
Object with information about the city
subdivision
object
Object describing the first-level administrative region (state/province)
location
object
Object holding detailed geographic and postal information
continent
object
Object with information about the continent
{
"type": "maxmind",
"iso2Code": "NL",
"recommendedCurrency": "EUR",
"possibleVatPercent": 21,
"city": {
"name": "Amsterdam"
},
"subdivision": {
"name": "North Holland",
"isoCode": "NH"
},
"location": {
"latitude": 52.3759,
"longitude": 4.8975,
"timezone": "Europe/Amsterdam",
"postalCode": "1012"
},
"continent": {
"name": "Europe",
"isoCode": "EU"
}
}Errors and interpretation
The list of possible errors for this endpoint, along with their types and interpretation, is provided in the general reference: Endpoint response errors.