/**
 * 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.
 */
/**
 * This object contains recurring payment information.
 * @export
 * @interface Ptsv2paymentsRecurringPaymentInformation
 */
export interface Ptsv2paymentsRecurringPaymentInformation {
    /**
     * The date after which no further recurring authorizations should be performed. Format: `YYYY-MM-DD` **Note** This field is required for recurring transactions.
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    endDate?: string;
    /**
     * Integer value indicating the minimum number of days between recurring authorizations. A frequency of monthly is indicated by the value 28. Multiple of 28 days will be used to indicate months.  Example: 6 months = 168  Example values accepted (31 days): - 31 - 031 - 0031  **Note** This field is required for recurring transactions.
     * @type {number}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    frequency?: number;
    /**
     * Total number of payments for the duration of the recurring subscription.
     * @type {number}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    numberOfPayments?: number;
    /**
     * Date of original purchase. Required for recurring transactions. Format: `YYYY-MM-DDTHH:MM:SSZ` **Note**: If this field is empty, the current date is used.
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    originalPurchaseDate?: string;
    /**
     * This field is mandatory for Cartes Bancaires recurring transactions on Credit Mutuel-CIC.       This field records recurring sequence, e.g. 1st for initial,  2 for subsequent, 3 etc
     * @type {number}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    sequenceNumber?: number;
    /**
     * This contains the type of recurring payment. Valid Values : 1 - Registration/First transaction 2 - Subsequent transaction 3 - Modification 4 - Cancellation
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    type?: string;
    /**
     * This value indicates how often a recurring payment occurs. Valid Values : • 01 (Daily) • 02 (Twice weekly) • 03 (Weekly) • 04 (Ten days) • 05 (Fortnightly) • 06 (Monthly) • 07 (Every two months) • 08 (Trimester) • 09 (Quarterly) • 10 (Twice yearly) • 11 (Annually) • 12 (Unscheduled)
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    occurrence?: string;
    /**
     * This tag will contain a value that indicates whether or not the recurring payment transaction has been validated. Valid values : 0- Not validated 1- Validated
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    validationIndicator?: string;
    /**
     * Indicates recurring amount type agreed by the cardholder Valid Values : 1- Fixed amount recurring payment 2- Recurring payment with maximum amount
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    amountType?: string;
    /**
     * This API field will contain the maximum amount agreed to by the cardholder. The currency of this amount will be specified in Field 49—Currency Code,Transaction.
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    maximumAmount?: string;
    /**
     * This will contain a unique reference number for the recurring payment transaction.
     * @type {string}
     * @memberof Ptsv2paymentsRecurringPaymentInformation
     */
    referenceNumber?: string;
}
