@paciolan/cybersource-sdk/dist/models/ptsv2payouts-sender-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 { Ptsv2payoutsSenderInformationAccount } from './ptsv2payouts-sender-information-account';
/**
 *
 * @export
 * @interface Ptsv2payoutsSenderInformation
 */
export interface Ptsv2payoutsSenderInformation {
    /**
     * Reference number generated by you that uniquely identifies the sender.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    referenceNumber?: string;
    /**
     *
     * @type {Ptsv2payoutsSenderInformationAccount}
     * @memberof Ptsv2payoutsSenderInformation
     */
    account?: Ptsv2payoutsSenderInformationAccount;
    /**
     * First name of sender (Optional). * CTV (14) * Paymentech (30)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    firstName?: string;
    /**
     * Recipient middle initial (Optional).
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    middleInitial?: 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 Ptsv2payoutsSenderInformation
     */
    middleName?: string;
    /**
     * Recipient last name (Optional). * CTV (14) * Paymentech (30)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    lastName?: string;
    /**
     * Name of sender.  **Funds Disbursement**  This value is the name of the originator sending the funds disbursement. * CTV, Paymentech (30)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    name?: string;
    /**
     * Street address of sender.  **Funds Disbursement**  This value is the address of the originator sending the funds disbursement.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    address1?: string;
    /**
     * City of sender.  **Funds Disbursement**  This value is the city of the originator sending the funds disbursement.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    locality?: string;
    /**
     * Sender's state. 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).
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    administrativeArea?: string;
    /**
     * Country of sender. Use the [ISO Standard Country Codes](https://developer.cybersource.com/library/documentation/sbc/quickref/countries_alpha_list.pdf). * CTV (3)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    countryCode?: string;
    /**
     * Sender's postal code. Required only for FDCCompass.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    postalCode?: string;
    /**
     * Sender's phone number. Required only for FDCCompass.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    phoneNumber?: string;
    /**
     * Sender's date of birth in YYYYMMDD format. Required only for FDCCompass.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    dateOfBirth?: string;
    /**
     * Customer's government-assigned tax identification number.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    vatRegistrationNumber?: string;
    /**
     * #### Visa Platform Connect This tag will contain the type of sender identification. The valid values are: • BTHD (Date of birth) • CUID (Customer identification (unspecified)) • NTID (National identification) • PASN (Passport number) • DRLN (Driver license) • TXIN (Tax identification) • CPNY (Company registration number) • PRXY (Proxy identification) • SSNB (Social security number) • ARNB (Alien registration number) • LAWE (Law enforcement identification) • MILI (Military identification) • TRVL (Travel identification (non-passport)) • EMAL (Email) • PHON (Phone number)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    personalIdType?: string;
    /**
     * #### Visa Platform Connect This tag will denote whether the tax ID is a business or individual tax ID when personal ID Type contains the value of TXIN (Tax identification).  The valid values are: • B (Business) • I (Individual)
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    type?: string;
    /**
     * #### Visa Platform Connect This tag will contain an acquirer-populated value associated with the API : senderInformation.personalIdType which will identify the personal ID type of the sender.
     * @type {string}
     * @memberof Ptsv2payoutsSenderInformation
     */
    identificationNumber?: string;
}