Edit

Share via

PaymentAddress interface

  • Reference
Package:
botframework-schema

Warning

This API is now deprecated.

Bot Framework no longer supports payments

Address within a Payment Request

Properties

addressLine

This is the most specific part of the address. It can include, for example, a street name, a house number, apartment number, a rural delivery route, descriptive instructions, or a post office box number.
city

This is the city/town portion of the address.
country

This is the CLDR (Common Locale Data Repository) region code. For example, US, GB, CN, or JP
dependentLocality

This is the dependent locality or sublocality within a city. For example, used for neighborhoods, boroughs, districts, or UK dependent localities.
languageCode

This is the BCP-47 language code for the address. It's used to determine the field separators and the order of fields when formatting the address for display.
organization

This is the organization, firm, company, or institution at this address.
phone

This is the phone number of the recipient or contact person.
postalCode

This is the postal code or ZIP code, also known as PIN code in India.
recipient

This is the name of the recipient or contact person.
region

This is the top level administrative subdivision of the country. For example, this can be a state, a province, an oblast, or a prefecture.
sortingCode

This is the sorting code as used in, for example, France.

Property Details

addressLine

This is the most specific part of the address. It can include, for example, a street name, a house number, apartment number, a rural delivery route, descriptive instructions, or a post office box number.

addressLine: string[]

Property Value

string[]

city

This is the city/town portion of the address.

city: string

Property Value

string

country

This is the CLDR (Common Locale Data Repository) region code. For example, US, GB, CN, or JP

country: string

Property Value

string

dependentLocality

This is the dependent locality or sublocality within a city. For example, used for neighborhoods, boroughs, districts, or UK dependent localities.

dependentLocality: string

Property Value

string

languageCode

This is the BCP-47 language code for the address. It's used to determine the field separators and the order of fields when formatting the address for display.

languageCode: string

Property Value

string

organization

This is the organization, firm, company, or institution at this address.

organization: string

Property Value

string

phone

This is the phone number of the recipient or contact person.

phone: string

Property Value

string

postalCode

This is the postal code or ZIP code, also known as PIN code in India.

postalCode: string

Property Value

string

recipient

This is the name of the recipient or contact person.

recipient: string

Property Value

string

region

This is the top level administrative subdivision of the country. For example, this can be a state, a province, an oblast, or a prefecture.

region: string

Property Value

string

sortingCode

This is the sorting code as used in, for example, France.

sortingCode: string

Property Value

string