@sumup/sdk/dist/types/merchant.d.cts

The official TypeScript SDK for the SumUp API

import type { BusinessProfile } from "./business-profile";
import type { ChangeStatus } from "./change-status";
import type { ClassicMerchantIdentifiers } from "./classic-merchant-identifiers";
import type { Company } from "./company";
import type { CountryCode } from "./country-code";
import type { Meta } from "./meta";
import type { Timestamps } from "./timestamps";
import type { Version } from "./version";
/**
 * Merchant
 *
 * Merchant documentation: https://developer.sumup.com/tools/glossary/merchant
 */
export type Merchant = {
    /**
     * Short unique identifier for the merchant.
     */
    readonly merchant_code: string;
    /**
     * ID of the organization the merchant belongs to (if any).
     */
    organization_id?: 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
     *
     */
    business_type?: string;
    company?: Company;
    country: CountryCode;
    business_profile?: BusinessProfile;
    /**
     * A user-facing small-format logo for use in dashboards and other user-facing applications. For customer-facing branding see `merchant.business_profile.branding`.
     *
     */
    avatar?: 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`.
     *
     */
    alias?: string;
    /**
     * Three-letter [ISO currency code](https://en.wikipedia.org/wiki/ISO_4217) representing the default currency for the account.
     *
     */
    readonly default_currency: string;
    /**
     * 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.
     */
    default_locale: string;
    /**
     * True if the merchant is a sandbox for testing.
     */
    sandbox?: boolean;
    meta?: Meta;
    classic?: ClassicMerchantIdentifiers;
    version?: Version;
    change_status?: ChangeStatus;
} & Timestamps;
//# sourceMappingURL=merchant.d.cts.map