@sumup/sdk
    Preparing search index...

    Type Alias 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.

    Address documentation: https://sumup.roadie.so/docs/default/Component/merchants/merchant/#addresses

    type Address = {
        autonomous_community?: string;
        city?: string;
        commune?: string;
        country: CountryCode;
        county?: string;
        department?: string;
        district?: string;
        eircode?: string;
        municipality?: string;
        neighborhood?: string;
        post_code?: string;
        post_town?: string;
        province?: string;
        region?: string;
        state?: string;
        street_address?: string[];
        zip_code?: string;
    }
    Index

    Properties

    autonomous_community? city? commune? country county? department? district? eircode? municipality? neighborhood? post_code? post_town? province? region? state? street_address? zip_code?

    Properties

    autonomous_community?: string

    In Spain, an autonomous community is the first sub-national level of political and administrative division.

    city?: string

    The city of the address.

    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.

    country: CountryCode
    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.

    department?: string

    A department (French: département, Spanish: departamento) is an administrative or political division in several countries. 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.

    eircode?: string

    A postal address in Ireland.

    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.

    neighborhood?: string

    Locality level of the address. Used in countries such as Brazil or Chile.

    Optionalpost_code

    post_code?: string

    The postal code (aka. zip code) of the address.

    Optionalpost_town

    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.

    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.

    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.

    street_address?: string[]
    zip_code?: string

    A US system of postal codes used by the United States Postal Service (USPS).

    Settings

    Member Visibility

    On This Page

    Properties