@paciolan/cybersource-sdk/dist/models/ptsv2paymentreferences-order-information-ship-to.d.ts

CyberSource REST API Typescript SDK

/**
 * CyberSource Merged Spec
 * All CyberSource API specs merged together. These are available at https://developer.cybersource.com/api/reference/api-reference.html
 *
 * OpenAPI spec version: 0.0.1
 *
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */
/**
 *
 * @export
 * @interface Ptsv2paymentreferencesOrderInformationShipTo
 */
export interface Ptsv2paymentreferencesOrderInformationShipTo {
    /**
     * Customer's primary email address, including the full domain name.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    email?: string;
    /**
     * The title of the person receiving the product.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    title?: string;
    /**
     * First name of the recipient.  #### Litle Maximum length: 25  #### All other processors Maximum length: 60  Optional field.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    firstName?: string;
    /**
     * Middle name of the recipient.  #### Litle Maximum length: 25  #### All other processors Maximum length: 60  Optional field.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    middleName?: string;
    /**
     * Last name of the recipient.  #### Litle Maximum length: 25  #### All other processors Maximum length: 60  Optional field.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    lastName?: string;
    /**
     * Name of the customer's company.  For processor-specific information, see the company_name field in [Credit Card Services Using the SCMP API.](http://apps.cybersource.com/library/documentation/dev_guides/CC_Svcs_SCMP_API/html)
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    company?: string;
    /**
     * First line of the shipping address.  Required field for authorization if any shipping address information is included in the request; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    address1?: string;
    /**
     * Second line of the shipping address.  Optional field.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    address2?: string;
    /**
     * Neighborhood, community, or region within a city or municipality.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    district?: string;
    /**
     * City of the shipping address.  Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    locality?: string;
    /**
     * State or province of the shipping address. Use the [State, Province, and Territory Codes for the United States and Canada](https://developer.cybersource.com/library/documentation/sbc/quickref/states_and_provinces.pdf) (maximum length: 2)   Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    administrativeArea?: string;
    /**
     * Postal code for the shipping address. The postal code must consist of 5 to 9 digits.  Required field for authorization if any shipping address information is included in the request and shipping to the U.S. or Canada; otherwise, optional.  When the billing country is the U.S., the 9-digit postal code must follow this format: [5 digits][dash][4 digits]  Example 12345-6789  When the billing country is Canada, the 6-digit postal code must follow this format: [alpha][numeric][alpha][space][numeric][alpha][numeric]  Example A1B 2C3  #### American Express Direct Before sending the postal code to the processor, all nonalphanumeric characters are removed and, if the remaining value is longer than nine characters, the value is truncated starting from the right side. #### Tax Calculation Optional field for U.S. and Canadian taxes. Not applicable to international and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    postalCode?: string;
    /**
     * Country of the shipping address. Use the two-character [ISO Standard Country Codes.](http://apps.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf)  Required field for authorization if any shipping address information is included in the request; otherwise, optional.  #### Tax Calculation Optional field for U.S., Canadian, international tax, and value added taxes. Billing address objects will be used to determine the cardholder's location when shipTo objects are not present.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    country?: string;
    /**
     * Building number in the street address. For example, the building number is 187 in the following address:  Rua da Quitanda 187
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    buildingNumber?: string;
    /**
     * Phone number associated with the shipping address.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    phoneNumber?: string;
    /**
     * Indicates whether customers are permitted to edit the shipping address in their PayPal account. Possible values: - true: Customer cannot edit the shipping address. - false (default): Customer can edit the shipping address.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    immutable?: string;
    /**
     * Indicates whether the shipping address is displayed to the customer in their PayPal account. Possible values: - true: Shipping address is not displayed. - false (default): Shipping address is displayed. For example, for digital downloads and services in which a shipping address is not required, set the value to true.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    notApplicable?: string;
    /**
     * U.S. county if available.
     * @type {string}
     * @memberof Ptsv2paymentreferencesOrderInformationShipTo
     */
    county?: string;
}