Skip to main content
GET
/
merchants
Get merchants
curl --request GET \
  --url https://sandbox.hellgate.io/merchants \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "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": ""
        }
      ]
    }
  ],
  "pagination": {
    "current_page": 1,
    "page_size": 1,
    "total_items": 1,
    "total_pages": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer

The desired amount of records per page. The parameter defaults to 50 if it is omitted and has a maximum of 500.

Required range: 1 <= x <= 500
​
page
integer

The desired number of the page to return.

Required range: x >= 1
​
sort
string

It allows sorting the result by legal_name or created_at. e.g sort=legal_name+asc or sort=legal_name+desc

​
from
string<date-time>

Return only merchants created from this date (YYYY-MM-DD).

​
to
string<date-time>

Return only merchants created up to this date (YYYY-MM-DD).

​
country_code
string

Contry code in a list format e.g country_code=DE, country_code=US,AUS.

The ISO 3166 two letter country code

Response

Success response

​
data
object[]
​
pagination
object

The meta-data describing lists of data from the Commerce API. The pages are indexed from 1 up to the total_pages.

Example:
{
  "current_page": 1,
  "page_size": 1,
  "total_items": 1,
  "total_pages": 1
}