@getopenpay/client/models/PaymentIntentExternal.d.ts

OpenPay API TypeScript SDK

/**
 * OpenPay API
 * super charge your subscription management.
 *
 * The version of the OpenAPI document: 1.2.1
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import type { PaymentIntentStatus } from './PaymentIntentStatus';
import type { InvoiceExternal } from './InvoiceExternal';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
/**
 *
 * @export
 * @interface PaymentIntentExternal
 */
export interface PaymentIntentExternal {
    /**
     *
     * @type {number}
     * @memberof PaymentIntentExternal
     */
    amountAtom: number;
    /**
     *
     * @type {number}
     * @memberof PaymentIntentExternal
     */
    amountAtomCapturable: number | null;
    /**
     *
     * @type {number}
     * @memberof PaymentIntentExternal
     */
    amountAtomReceived: number | null;
    /**
     *
     * @type {Array<string>}
     * @memberof PaymentIntentExternal
     */
    chargeIds: Array<string>;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentIntentExternal
     */
    createdAt: Date;
    /**
     *
     * @type {CurrencyEnum}
     * @memberof PaymentIntentExternal
     */
    currency: CurrencyEnum;
    /**
     *
     * @type {object}
     * @memberof PaymentIntentExternal
     */
    customFields?: object | null;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    customerId: string;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    declineReason: string | null;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    id: string;
    /**
     *
     * @type {InvoiceExternal}
     * @memberof PaymentIntentExternal
     */
    invoice: InvoiceExternal | null;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    invoiceId: string | null;
    /**
     *
     * @type {number}
     * @memberof PaymentIntentExternal
     */
    invoicePaymentProviderTypeFee: number | null;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof PaymentIntentExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {Date}
     * @memberof PaymentIntentExternal
     */
    lastRefundDate: Date | null;
    /**
     *
     * @type {ObjectName}
     * @memberof PaymentIntentExternal
     */
    object?: ObjectName;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    paymentMethodId: string | null;
    /**
     *
     * @type {string}
     * @memberof PaymentIntentExternal
     */
    paymentProcessorName: string | null;
    /**
     *
     * @type {Array<string>}
     * @memberof PaymentIntentExternal
     */
    refundIds: Array<string>;
    /**
     *
     * @type {PaymentIntentStatus}
     * @memberof PaymentIntentExternal
     */
    status: PaymentIntentStatus;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof PaymentIntentExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the PaymentIntentExternal interface.
 */
export declare function instanceOfPaymentIntentExternal(value: object): value is PaymentIntentExternal;
export declare function PaymentIntentExternalFromJSON(json: any): PaymentIntentExternal;
export declare function PaymentIntentExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): PaymentIntentExternal;
export declare function PaymentIntentExternalToJSON(json: any): PaymentIntentExternal;
export declare function PaymentIntentExternalToJSONTyped(value?: PaymentIntentExternal | null, ignoreDiscriminator?: boolean): any;