@paciolan/cybersource-sdk/dist/models/ptsv1pushfundstransfer-recipient-information.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.
 */
import { Ptsv1pushfundstransferRecipientInformationPaymentInformation } from './ptsv1pushfundstransfer-recipient-information-payment-information';
import { Ptsv1pushfundstransferRecipientInformationPersonalIdentification } from './ptsv1pushfundstransfer-recipient-information-personal-identification';
/**
 *
 * @export
 * @interface Ptsv1pushfundstransferRecipientInformation
 */
export interface Ptsv1pushfundstransferRecipientInformation {
    /**
     *
     * @type {Ptsv1pushfundstransferRecipientInformationPaymentInformation}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    paymentInformation?: Ptsv1pushfundstransferRecipientInformationPaymentInformation;
    /**
     * First line of the recipient's address.  Required for Mastercard Send. This field is not supported for Visa Platform Connect.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    address1?: string;
    /**
     * Second line of the recipient's address  Optional for Mastercard Send. This field is not supported for Visa Platform Connect.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    address2?: string | null;
    /**
     * Recipient city.  Required for Mastercard Send.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    locality?: string;
    /**
     * Recipient postal code.  For USA, this must be a valid value of 5 digits or 5 digits hyphen 4 digits, for example '63368', '63368-5555'. For other regions, this can be alphanumeric, length 1-10.  Mastercard Send: Required for recipients in Canada and Canadian issued cards.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    postalCode?: string;
    /**
     * The recipient's province, state or territory. Conditional, required if recipient's country is USA or CAN. Must be an ISO 3166-2 uppercase alpha 2 or 3 character country subdivision code. For example, Missouri is MO.  Required only for FDCCompass.  This field is not supported for Visa Platform Connect.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    administrativeArea?: string | null;
    /**
     * Recipient country code. Use the ISO Standard Alpha Country Codes.  https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf  Required for Mastercard Send.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    country?: string;
    /**
     * First name of recipient.  Visa Platform Connect (14) Chase Paymentech (30) Mastercard Send (40)  This field is required for Mastercard Send.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    firstName?: string;
    /**
     * Sender's middle name. This field is a passthrough, which means that CyberSource does not verify the value or modify it in any way before sending it to the processor. If the field is not required for the transaction, CyberSource does not forward it to the processor.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    middleName?: string | null;
    /**
     * Middle Initial of recipient.  This field is supported by FDC Compass.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    middleInitial?: string | null;
    /**
     * Last name of recipient.  Visa Platform Connect (14) Paymentech (30) Mastercard Send (40)  This field is required for Mastercard Send.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    lastName?: string | null;
    /**
     * Recipient date of birth in YYYYMMDD format.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    dateOfBirth?: string | null;
    /**
     * Recipient phone number.  This field is supported by FDC Compass.  Mastercard Send: Max length is 15 with no dashes or spaces.
     * @type {string}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    phoneNumber?: string;
    /**
     *
     * @type {Ptsv1pushfundstransferRecipientInformationPersonalIdentification}
     * @memberof Ptsv1pushfundstransferRecipientInformation
     */
    personalIdentification?: Ptsv1pushfundstransferRecipientInformationPersonalIdentification;
}