Skip to main content
POST
/
merchants
Create a merchant
curl --request POST \
  --url https://sandbox.hellgate.io/merchants \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "company_city": "Berlin",
  "country_code": "DE",
  "legal_name": "Example Merchant",
  "website_url": "https://example.com",
  "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": ""
    }
  ]
}
'
{
  "id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2023-10-10T00:00:00Z",
  "company_city": "Berlin",
  "country_code": "DE",
  "encryption_key": "eyJhbGciOiJSUzI1NiIsImVudGl0bGVtZW50IjoiYWF4NXdq...",
  "legal_name": "Example Merchant",
  "website_url": "https://example.com"
}

Authorizations

​
X-API-Key
string
header
required

Body

application/json
​
company_city
string
required

The city in the merchant's primary address.

​
country_code
string
required

A two letter country code. ISO 3166-1 alpha-2

​
legal_name
string
required

The name of the merchant

​
website_url
string<uri>
required

The URL of the merchant's website

​
identity_and_verification_enabled
boolean

The flag indicates if the 3DS identity and verification is required or not (only allowed for primary)

​
3ds_enabled
boolean

Indicates if 3DS is available or not for the Merchant

​
default_currency
string

The three letter currency code. See: ISO-4217

​
default_merchant_id
string

The id for the Merchant

​
schemes
object[]

The schemes supported by the merchant (required if merchant has a merchant_id)

Response

Success response

​
id
string<uuid>
required

The ID of the merchant

​
created_at
string<date-time>
required

The date-time the merchant was created (following ISO 8601)

​
company_city
string
required

The city in the merchant's primary address.

​
country_code
string
required

A two letter country code. ISO 3166-1 alpha-2

​
encryption_key
string
required

The key used to encrypt authentication data (for instance network token and cryptogram). This information is returned only once, when the merchant was initially created. Subsequent calls will return a masked value.

​
legal_name
string
required

The name of the merchant

​
website_url
string<uri>
required

The URL of the merchant's website