conekta/model/checkout-request.ts

OpenAPI client for conekta

/* tslint:disable */
/* eslint-disable */
/**
 * Conekta API
 * Conekta sdk
 *
 * The version of the OpenAPI document: 2.2.0
 * Contact: engineering@conekta.com
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */



/**
 * [Checkout](https://developers.conekta.com/v2.2.0/reference/payment-link) details 
 * @export
 * @interface CheckoutRequest
 */
export interface CheckoutRequest {
    /**
     * Are the payment methods available for this link. For subscriptions, only \'card\' is allowed due to the recurring nature of the payments.
     * @type {Array<string>}
     * @memberof CheckoutRequest
     */
    'allowed_payment_methods': Array<CheckoutRequestAllowedPaymentMethodsEnum>;
    /**
     * List of plan IDs that will be available for subscription. This field is required for subscription payments.
     * @type {Array<string>}
     * @memberof CheckoutRequest
     */
    'plan_ids'?: Array<string>;
    /**
     * Unix timestamp of checkout expiration
     * @type {number}
     * @memberof CheckoutRequest
     */
    'expires_at'?: number;
    /**
     * Redirection url back to the site in case of failed payment, applies only to HostedPayment.
     * @type {string}
     * @memberof CheckoutRequest
     */
    'failure_url'?: string;
    /**
     * 
     * @type {boolean}
     * @memberof CheckoutRequest
     */
    'monthly_installments_enabled'?: boolean;
    /**
     * 
     * @type {Array<number>}
     * @memberof CheckoutRequest
     */
    'monthly_installments_options'?: Array<number>;
    /**
     * Number of retries allowed before the checkout is marked as failed
     * @type {number}
     * @memberof CheckoutRequest
     */
    'max_failed_retries'?: number;
    /**
     * Reason for payment
     * @type {string}
     * @memberof CheckoutRequest
     */
    'name'?: string;
    /**
     * 
     * @type {boolean}
     * @memberof CheckoutRequest
     */
    'on_demand_enabled'?: boolean;
    /**
     * number of seconds to wait before redirecting to the success_url
     * @type {number}
     * @memberof CheckoutRequest
     */
    'redirection_time'?: number;
    /**
     * Redirection url back to the site in case of successful payment, applies only to HostedPayment
     * @type {string}
     * @memberof CheckoutRequest
     */
    'success_url'?: string;
    /**
     * This field represents the type of checkout
     * @type {string}
     * @memberof CheckoutRequest
     */
    'type'?: string;
}

export const CheckoutRequestAllowedPaymentMethodsEnum = {
    cash: 'cash',
    card: 'card',
    bankTransfer: 'bank_transfer',
    bnpl: 'bnpl',
    payByBank: 'pay_by_bank'
} as const;

export type CheckoutRequestAllowedPaymentMethodsEnum = typeof CheckoutRequestAllowedPaymentMethodsEnum[keyof typeof CheckoutRequestAllowedPaymentMethodsEnum];