@sumup/sdk
    Preparing search index...

    Type Alias Merchant

    Merchant: {
        alias?: string;
        avatar?: string;
        business_profile?: BusinessProfile;
        business_type?: string;
        change_status?: ChangeStatus;
        classic?: ClassicMerchantIdentifiers;
        company?: Company;
        country: CountryCode;
        default_currency: string;
        default_locale: string;
        merchant_code: string;
        meta?: SumUp.Merchants.Meta;
        organization_id?: string;
        sandbox?: boolean;
        version?: Version;
    } & Timestamps

    Merchant

    Merchant documentation: https://developer.sumup.com/tools/models/merchant

    Type Declaration

    • Optionalalias?: 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.

    • Optionalavatar?: string

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

    • Optionalbusiness_profile?: BusinessProfile
    • Optionalbusiness_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
    • Optionalchange_status?: ChangeStatus
    • Optionalclassic?: ClassicMerchantIdentifiers
    • Optionalcompany?: Company
    • country: CountryCode
    • default_currency: string

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

    • default_locale: string

      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.

    • merchant_code: string

      Short unique identifier for the merchant.

    • Optionalmeta?: SumUp.Merchants.Meta
    • Optionalorganization_id?: string

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

    • Optionalsandbox?: boolean

      True if the merchant is a sandbox for testing.

    • Optionalversion?: Version

    Settings

    Member Visibility