Sign in
Merchants

Retrieve a Merchant

Retrieve a merchant.

get/v1/merchants/{merchant_code}

Path parameters

merchant_codestring required
Example:MK10CL2A

Merchant code.

Query parameters

versionstring

The version of the resource. At the moment, the only supported value is latest. When provided and the requested resource's change_status is pending, the resource will be returned with all pending changes applied. When no changes are pending the resource is returned as is. The change_status in the response body will reflect the current state of the resource.

Response

Returns a Merchant for a valid identifier.

merchant_codestring required

Short unique identifier for the merchant.

organization_idstring

ID of the organization the merchant belongs to (if any).

business_typestring

The business type.

  • sole_trader: The business is run by an self-employed individual.
  • company: The business is run as a company with one or more shareholders
  • partnership: The business is run as a company with two or more shareholders that can be also other legal entities
  • non_profit: The business is run as a nonprofit organization that operates for public or social benefit
  • government_entity: The business is state owned and operated
countrystring required

An ISO3166-1 alpha-2 country code. This definition users oneOf with a two-character string type to allow for support of future countries in client code.

avatarstring url

A user-facing small-format logo for use in dashboards and other user-facing applications. For customer-facing branding see merchant.business_profile.branding.

aliasstring

A user-facing name of the merchant account for use in dashboards and other user-facing applications. For customer-facing business name see merchant.business_profile.

default_currencystring required

Three-letter ISO currency code representing the default currency for the account.

default_localestring required

Merchant's default locale, represented as a BCP47 RFC5646 language tag. This is typically an ISO 639-1 Alpha-2 ISO639‑1 language code in lowercase and an ISO 3166-1 Alpha-2 ISO3166‑1 country code in uppercase, separated by a dash. For example, en-US or fr-CA. In multilingual countries this is the merchant's preferred locale out of those, that are officially spoken in the country. In a countries with a single official language this will match the official language.

sandboxboolean

True if the merchant is a sandbox for testing.

metaMeta

A set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Warning: Updating Meta will overwrite the existing data. Make sure to always include the complete JSON object.

versionstring

The version of the resource. The version reflects a specific change submitted to the API via one of the PATCH endpoints.

change_statusstring

Reflects the status of changes submitted through the PATCH endpoints for the merchant or persons. If some changes have not been applied yet, the status will be pending. If all changes have been applied, the status done. The status is only returned after write operations or on read endpoints when the version query parameter is provided.

created_atstring date-time required

The date and time when the resource was created. This is a string as defined in RFC 3339, section 5.6.

updated_atstring date-time required

The date and time when the resource was last updated. This is a string as defined in RFC 3339, section 5.6.

Example response

{
  "merchant_code": "MK01A8C2",
  "organization_id": "G0UZPVAX",
  "company": {
    "name": "Gin & Doughnuts Bar GmbH",
    "merchant_category_code": "1532",
    "address": {
      "street_address": [
        "Paul-Linke-Ufer 39-40",
        "2. Hinterhof"
      ],
      "post_code": "10999",
      "city": "Berlin",
      "country": "DE"
    },
    "trading_address": {
      "street_address": [
        "Paul-Linke-Ufer 39-40",
        "2. Hinterhof"
      ],
      "post_code": "10999",
      "city": "Berlin",
      "country": "DE"
    },
    "phone_number": "+420123456789",
    "attributes": {}
  },
  "country": "BR",
  "business_profile": {
    "name": "Gin & Dougnuts",
    "website": "https://gindoughnuts.com",
    "email": "contact@gindoughnuts.com",
    "phone_number": "+420123456789",
    "address": {
      "street_address": [
        "Paul-Linke-Ufer 39-40",
        "2. Hinterhof"
      ],
      "post_code": "10999",
      "city": "Berlin",
      "country": "DE"
    }
  },
  "default_currency": "EUR",
  "default_locale": "de-DE",
  "meta": {},
  "classic": {
    "id": 1234
  }
}

Changes