---
title: "Get Merchant"
method: GET
path: "/v1/merchants/{merchant_code}"
tags: ["Merchants"]
---

# Get Merchant

`GET /v1/merchants/{merchant_code}`

Returns a Merchant for a valid Merchant code.

## Path parameters

- `merchant_code` string, required

## Query parameters

- `version` string

## Response `200`

Returns a Merchant for a valid identifier.

- Merchant
  - `merchant_code` string, required — Short unique identifier for the merchant.
  - `organization_id` string — ID of the organization the merchant belongs to (if any).
  - `business_type` string — 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
  - `company` Company — Information about the company or business. This is legal information that is used for verification.
    - `name` string — The company's legal name.
    - `merchant_category_code` string — The merchant category code for the account as specified by [ISO18245](https://www.iso.org/standard/33365.html). MCCs are used to classify businesses based on the goods or services they provide.
    - `legal_type` string — The unique legal type reference as defined in the country SDK. We do not rely on IDs as used by other services. Consumers of this API are expected to use the country SDK to map to any other IDs, translation keys, or descriptions.
    - `address` Address — An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`. Whether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.
      - `street_address` string[]
      - `post_code` string — The postal code (aka. zip code) of the address.
      - `country` string, required — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-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.
      - `city` string — The city of the address.
      - `province` string — The province where the address is located. This may not be relevant in some countries.
      - `region` string — The region where the address is located. This may not be relevant in some countries.
      - `county` string — A county is a geographic region of a country used for administrative or other purposes in some nations. Used in countries such as Ireland, Romania, etc.
      - `autonomous_community` string — In Spain, an autonomous community is the first sub-national level of political and administrative division.
      - `post_town` string — A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit of the postal delivery system.
      - `state` string — Most often, a country has a single state, with various administrative divisions. The term "state" is sometimes used to refer to the federated polities that make up the federation. Used in countries such as the United States and Brazil.
      - `neighborhood` string — Locality level of the address. Used in countries such as Brazil or Chile.
      - `commune` string — In many countries, terms cognate with "commune" are used, referring to the community living in the area and the common interest. Used in countries such as Chile.
      - `department` string — A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia.
      - `municipality` string — A municipality is usually a single administrative division having corporate status and powers of self-government or jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as Colombia.
      - `district` string — A district is a type of administrative division that in some countries is managed by the local government. Used in countries such as Portugal.
      - `zip_code` string — A US system of postal codes used by the United States Postal Service (USPS).
      - `eircode` string — A postal address in Ireland.
    - `trading_address` Address — An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`. Whether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.
      - `street_address` string[]
      - `post_code` string — The postal code (aka. zip code) of the address.
      - `country` string, required — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-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.
      - `city` string — The city of the address.
      - `province` string — The province where the address is located. This may not be relevant in some countries.
      - `region` string — The region where the address is located. This may not be relevant in some countries.
      - `county` string — A county is a geographic region of a country used for administrative or other purposes in some nations. Used in countries such as Ireland, Romania, etc.
      - `autonomous_community` string — In Spain, an autonomous community is the first sub-national level of political and administrative division.
      - `post_town` string — A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit of the postal delivery system.
      - `state` string — Most often, a country has a single state, with various administrative divisions. The term "state" is sometimes used to refer to the federated polities that make up the federation. Used in countries such as the United States and Brazil.
      - `neighborhood` string — Locality level of the address. Used in countries such as Brazil or Chile.
      - `commune` string — In many countries, terms cognate with "commune" are used, referring to the community living in the area and the common interest. Used in countries such as Chile.
      - `department` string — A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia.
      - `municipality` string — A municipality is usually a single administrative division having corporate status and powers of self-government or jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as Colombia.
      - `district` string — A district is a type of administrative division that in some countries is managed by the local government. Used in countries such as Portugal.
      - `zip_code` string — A US system of postal codes used by the United States Postal Service (USPS).
      - `eircode` string — A postal address in Ireland.
    - `identifiers` CompanyIdentifier[] — A list of country-specific company identifiers.
      - `ref` string, required — The unique reference for the company identifier type as defined in the country SDK.
      - `value` string, required — The company identifier value.
    - `phone_number` string — A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
    - `website` string — HTTP(S) URL of the company's website.
    - `attributes` Attributes — Object attributes that are modifiable only by SumUp applications.
  - `country` string, required — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-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.
  - `business_profile` BusinessProfile — Business information about the merchant. This information will be visible to the merchant's customers.
    - `name` string — The customer-facing business name.
    - `dynamic_descriptor` string — The descriptor is the text that your customer sees on their bank account statement. The more recognisable your descriptor is, the less risk you have of receiving disputes (e.g. chargebacks).
    - `website` string — The business's publicly available website.
    - `email` string — A publicly available email address.
    - `phone_number` string — A publicly available phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
    - `address` Address — An address somewhere in the world. The address fields used depend on the country conventions. For example, in Great Britain, `city` is `post_town`. In the United States, the top-level administrative unit used in addresses is `state`, whereas in Chile it's `region`. Whether an address is valid or not depends on whether the locally required fields are present. Fields not supported in a country will be ignored.
      - `street_address` string[]
      - `post_code` string — The postal code (aka. zip code) of the address.
      - `country` string, required — An [ISO3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-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.
      - `city` string — The city of the address.
      - `province` string — The province where the address is located. This may not be relevant in some countries.
      - `region` string — The region where the address is located. This may not be relevant in some countries.
      - `county` string — A county is a geographic region of a country used for administrative or other purposes in some nations. Used in countries such as Ireland, Romania, etc.
      - `autonomous_community` string — In Spain, an autonomous community is the first sub-national level of political and administrative division.
      - `post_town` string — A post town is a required part of all postal addresses in the United Kingdom and Ireland, and a basic unit of the postal delivery system.
      - `state` string — Most often, a country has a single state, with various administrative divisions. The term "state" is sometimes used to refer to the federated polities that make up the federation. Used in countries such as the United States and Brazil.
      - `neighborhood` string — Locality level of the address. Used in countries such as Brazil or Chile.
      - `commune` string — In many countries, terms cognate with "commune" are used, referring to the community living in the area and the common interest. Used in countries such as Chile.
      - `department` string — A department (French: département, Spanish: departamento) is an administrative or political division in several countries. Used in countries such as Colombia.
      - `municipality` string — A municipality is usually a single administrative division having corporate status and powers of self-government or jurisdiction as granted by national and regional laws to which it is subordinate. Used in countries such as Colombia.
      - `district` string — A district is a type of administrative division that in some countries is managed by the local government. Used in countries such as Portugal.
      - `zip_code` string — A US system of postal codes used by the United States Postal Service (USPS).
      - `eircode` string — A postal address in Ireland.
    - `branding` Branding — Settings used to apply the Merchant's branding to email receipts, invoices, checkouts, and other products.
      - `footer_text` string — Footer text rendered on receipts and other customer-facing products.
      - `icon` string, uri — An icon for the merchant. Must be square.
      - `logo` string, uri — A logo for the merchant that will be used in place of the icon and without the merchant's name next to it if there's sufficient space.
      - `hero` string, uri — Data-URL encoded hero image for the merchant business.
      - `primary_color` string — A hex color value representing the primary branding color of this merchant (your brand color).
      - `primary_color_fg` string — A hex color value representing the color of the text displayed on branding color of this merchant.
      - `secondary_color` string — A hex color value representing the secondary branding color of this merchant (accent color used for buttons).
      - `secondary_color_fg` string — A hex color value representing the color of the text displayed on secondary branding color of this merchant.
      - `background_color` string — A hex color value representing the preferred background color of this merchant.
  - `avatar` string, uri — A user-facing small-format logo for use in dashboards and other user-facing applications. For customer-facing branding see `merchant.business_profile.branding`.
  - `alias` string — 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_currency` string, required — Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) representing the default currency for the account.
  - `default_locale` string, required — Merchant's default locale, represented as a BCP47 [RFC5646](https://datatracker.ietf.org/doc/html/rfc5646) language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1](https://www.iso.org/iso-639-language-code) language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1](https://www.iso.org/iso-3166-country-codes.html) 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.
  - `sandbox` boolean — True if the merchant is a sandbox for testing.
  - `meta` Meta — 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.
  - `classic` ClassicMerchantIdentifiers
    - `id` integer, required — Classic (serial) merchant ID.
  - `version` string — The version of the resource. The version reflects a specific change submitted to the API via one of the `PATCH` endpoints.
  - `change_status` string — 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_at` string, date-time, required — The date and time when the resource was created. This is a string as defined in [RFC 3339, section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
  - `updated_at` string, 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](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).

## Other responses

- `404` — The requested Merchant does not exist.

---

[API](https://skmtc.net/sumup/apis/sumup-rest-api.md) · [All operations](https://skmtc.net/sumup/apis/sumup-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/sumup/sumup-rest-api/revisions/f50e1dc97523/schema)