@getopenpay/client/models/RefundExternal.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 { RefundStatusEnum } from './RefundStatusEnum';
import type { CurrencyEnum } from './CurrencyEnum';
import type { ObjectName } from './ObjectName';
import type { RefundReasonEnum } from './RefundReasonEnum';
/**
 *
 * @export
 * @interface RefundExternal
 */
export interface RefundExternal {
    /**
     * amount_atom that you want to refund.
     * @type {number}
     * @memberof RefundExternal
     */
    amountAtom: number;
    /**
     *
     * @type {string}
     * @memberof RefundExternal
     */
    attemptErrorMessage?: string | null;
    /**
     * Unique Identifier of the charge.
     * @type {string}
     * @memberof RefundExternal
     */
    chargeId: string;
    /**
     * DateTime at which the object was created, in 'ISO 8601' format.
     * @type {Date}
     * @memberof RefundExternal
     */
    createdAt: Date;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof RefundExternal
     */
    currency?: CurrencyEnum;
    /**
     * Unique Identifier of the refund.
     * @type {string}
     * @memberof RefundExternal
     */
    id: string;
    /**
     * Invoice id to which the refund is attached.
     * @type {string}
     * @memberof RefundExternal
     */
    invoiceId: string;
    /**
     * If true, indicates that this object has been deleted
     * @type {boolean}
     * @memberof RefundExternal
     */
    isDeleted?: boolean;
    /**
     *
     * @type {ObjectName}
     * @memberof RefundExternal
     */
    object?: ObjectName;
    /**
     * Unique Identifier of the payment_intent.
     * @type {string}
     * @memberof RefundExternal
     */
    paymentIntentId: string;
    /**
     * Reason of the refund.
     * @type {RefundReasonEnum}
     * @memberof RefundExternal
     */
    reason: RefundReasonEnum;
    /**
     * Status of the refund.
     * @type {RefundStatusEnum}
     * @memberof RefundExternal
     */
    status: RefundStatusEnum;
    /**
     * DateTime at which the object was updated, in 'ISO 8601' format.
     * @type {Date}
     * @memberof RefundExternal
     */
    updatedAt: Date;
}
/**
 * Check if a given object implements the RefundExternal interface.
 */
export declare function instanceOfRefundExternal(value: object): value is RefundExternal;
export declare function RefundExternalFromJSON(json: any): RefundExternal;
export declare function RefundExternalFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefundExternal;
export declare function RefundExternalToJSON(json: any): RefundExternal;
export declare function RefundExternalToJSONTyped(value?: RefundExternal | null, ignoreDiscriminator?: boolean): any;