Update merchant
Update the information of a merchant.
curl --request PATCH \
--url https://sandbox.hellgate.io/merchants/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"company_city": "<string>",
"country_code": "<string>",
"legal_name": "<string>",
"website_url": "<string>",
"identity_and_verification_enabled": true,
"3ds_enabled": true,
"default_currency": "<string>",
"default_merchant_id": "<string>",
"schemes": [
{
"acquirer_bin": "<string>",
"category_code": "<string>",
"requestor_id": "<string>",
"requestor_name": "<string>",
"merchant_id": "<string>",
"merchant_name": "<string>"
}
]
}
'import requests
url = "https://sandbox.hellgate.io/merchants/{id}"
payload = {
"company_city": "<string>",
"country_code": "<string>",
"legal_name": "<string>",
"website_url": "<string>",
"identity_and_verification_enabled": True,
"3ds_enabled": True,
"default_currency": "<string>",
"default_merchant_id": "<string>",
"schemes": [
{
"acquirer_bin": "<string>",
"category_code": "<string>",
"requestor_id": "<string>",
"requestor_name": "<string>",
"merchant_id": "<string>",
"merchant_name": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_city: '<string>',
country_code: '<string>',
legal_name: '<string>',
website_url: '<string>',
identity_and_verification_enabled: true,
'3ds_enabled': true,
default_currency: '<string>',
default_merchant_id: '<string>',
schemes: [
{
acquirer_bin: '<string>',
category_code: '<string>',
requestor_id: '<string>',
requestor_name: '<string>',
merchant_id: '<string>',
merchant_name: '<string>'
}
]
})
};
fetch('https://sandbox.hellgate.io/merchants/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hellgate.io/merchants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'company_city' => '<string>',
'country_code' => '<string>',
'legal_name' => '<string>',
'website_url' => '<string>',
'identity_and_verification_enabled' => true,
'3ds_enabled' => true,
'default_currency' => '<string>',
'default_merchant_id' => '<string>',
'schemes' => [
[
'acquirer_bin' => '<string>',
'category_code' => '<string>',
'requestor_id' => '<string>',
'requestor_name' => '<string>',
'merchant_id' => '<string>',
'merchant_name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hellgate.io/merchants/{id}"
payload := strings.NewReader("{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox.hellgate.io/merchants/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hellgate.io/merchants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "9071cd4e-9627-421b-96cc-d48ffda5e894",
"created_at": "2023-10-10T00:00:00Z",
"company_city": "Berlin",
"country_code": "DE",
"encryption_key": "eyJhbGciO[redacted]",
"legal_name": "Example Merchant",
"website_url": "https://example.com",
"type": "submerchant",
"identity_and_verification_enabled": false,
"3ds_enabled": true,
"default_currency": "EUR",
"default_merchant_id": "1234567890",
"schemes": [
{
"name": "visa",
"acquirer_bin": "40001",
"requestor_id": "123456789.visa",
"requestor_name": "3dsclient.local.visa",
"category_code": "3200",
"merchant_id": "",
"merchant_name": ""
}
]
}{
"code": 401,
"message": "No valid means of authentication was provided",
"classifier": "UNAUTHORIZED"
}{
"code": 403,
"message": "Not allowed to access this resource or feature",
"classifier": "FORBIDDEN"
}{
"code": 404,
"message": "The requested resource was not found.",
"classifier": "NOT_FOUND"
}Authorizations
Path Parameters
The ID of the merchant
Body
The city in the merchant's primary address.
A two letter country code. ISO 3166-1 alpha-2
The name of the merchant
The URL of the merchant's website
The flag indicates if the 3DS identity and verification is required or not (only allowed for primary)
Indicates if 3DS is available or not for the Merchant
The id for the Merchant
The schemes supported by the merchant (required if merchant has a merchant_id)
Show child attributes
Show child attributes
Response
Success response
The ID of the merchant
The date-time the merchant was created (following ISO 8601)
The city in the merchant's primary address.
A two letter country code. ISO 3166-1 alpha-2
The masked version of the key used to encrypt authentication data (for instance network token and cryptogram). A full copy of this information is returned only once, when the merchant was initially created.
The name of the merchant
The URL of the merchant's website
The merchant type
primary, submerchant The flag indicates if the 3DS identity and verification is required or not (only allowed for primary)
Indicates if 3DS is available or not for the Merchant
The id for the Merchant
The schemes supported by the merchant (required if merchant has a merchant_id)
Show child attributes
Show child attributes
curl --request PATCH \
--url https://sandbox.hellgate.io/merchants/{id} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"company_city": "<string>",
"country_code": "<string>",
"legal_name": "<string>",
"website_url": "<string>",
"identity_and_verification_enabled": true,
"3ds_enabled": true,
"default_currency": "<string>",
"default_merchant_id": "<string>",
"schemes": [
{
"acquirer_bin": "<string>",
"category_code": "<string>",
"requestor_id": "<string>",
"requestor_name": "<string>",
"merchant_id": "<string>",
"merchant_name": "<string>"
}
]
}
'import requests
url = "https://sandbox.hellgate.io/merchants/{id}"
payload = {
"company_city": "<string>",
"country_code": "<string>",
"legal_name": "<string>",
"website_url": "<string>",
"identity_and_verification_enabled": True,
"3ds_enabled": True,
"default_currency": "<string>",
"default_merchant_id": "<string>",
"schemes": [
{
"acquirer_bin": "<string>",
"category_code": "<string>",
"requestor_id": "<string>",
"requestor_name": "<string>",
"merchant_id": "<string>",
"merchant_name": "<string>"
}
]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
company_city: '<string>',
country_code: '<string>',
legal_name: '<string>',
website_url: '<string>',
identity_and_verification_enabled: true,
'3ds_enabled': true,
default_currency: '<string>',
default_merchant_id: '<string>',
schemes: [
{
acquirer_bin: '<string>',
category_code: '<string>',
requestor_id: '<string>',
requestor_name: '<string>',
merchant_id: '<string>',
merchant_name: '<string>'
}
]
})
};
fetch('https://sandbox.hellgate.io/merchants/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.hellgate.io/merchants/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'company_city' => '<string>',
'country_code' => '<string>',
'legal_name' => '<string>',
'website_url' => '<string>',
'identity_and_verification_enabled' => true,
'3ds_enabled' => true,
'default_currency' => '<string>',
'default_merchant_id' => '<string>',
'schemes' => [
[
'acquirer_bin' => '<string>',
'category_code' => '<string>',
'requestor_id' => '<string>',
'requestor_name' => '<string>',
'merchant_id' => '<string>',
'merchant_name' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox.hellgate.io/merchants/{id}"
payload := strings.NewReader("{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox.hellgate.io/merchants/{id}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.hellgate.io/merchants/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"company_city\": \"<string>\",\n \"country_code\": \"<string>\",\n \"legal_name\": \"<string>\",\n \"website_url\": \"<string>\",\n \"identity_and_verification_enabled\": true,\n \"3ds_enabled\": true,\n \"default_currency\": \"<string>\",\n \"default_merchant_id\": \"<string>\",\n \"schemes\": [\n {\n \"acquirer_bin\": \"<string>\",\n \"category_code\": \"<string>\",\n \"requestor_id\": \"<string>\",\n \"requestor_name\": \"<string>\",\n \"merchant_id\": \"<string>\",\n \"merchant_name\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "9071cd4e-9627-421b-96cc-d48ffda5e894",
"created_at": "2023-10-10T00:00:00Z",
"company_city": "Berlin",
"country_code": "DE",
"encryption_key": "eyJhbGciO[redacted]",
"legal_name": "Example Merchant",
"website_url": "https://example.com",
"type": "submerchant",
"identity_and_verification_enabled": false,
"3ds_enabled": true,
"default_currency": "EUR",
"default_merchant_id": "1234567890",
"schemes": [
{
"name": "visa",
"acquirer_bin": "40001",
"requestor_id": "123456789.visa",
"requestor_name": "3dsclient.local.visa",
"category_code": "3200",
"merchant_id": "",
"merchant_name": ""
}
]
}{
"code": 401,
"message": "No valid means of authentication was provided",
"classifier": "UNAUTHORIZED"
}{
"code": 403,
"message": "Not allowed to access this resource or feature",
"classifier": "FORBIDDEN"
}{
"code": 404,
"message": "The requested resource was not found.",
"classifier": "NOT_FOUND"
}