@getopenpay/client/models/CreateRefundRequest.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 { CurrencyEnum } from './CurrencyEnum';
import type { RefundReasonEnum } from './RefundReasonEnum';
/**
 *
 * @export
 * @interface CreateRefundRequest
 */
export interface CreateRefundRequest {
    /**
     *
     * @type {number}
     * @memberof CreateRefundRequest
     */
    amountAtom?: number | null;
    /**
     *
     * @type {string}
     * @memberof CreateRefundRequest
     */
    chargeId?: string | null;
    /**
     * Three-letter ISO currency code, in lowercase.
     * @type {CurrencyEnum}
     * @memberof CreateRefundRequest
     */
    currency?: CurrencyEnum;
    /**
     * Description of the refund.
     * @type {string}
     * @memberof CreateRefundRequest
     */
    description?: string;
    /**
     *
     * @type {string}
     * @memberof CreateRefundRequest
     */
    paymentIntentId?: string | null;
    /**
     * Reason of the refund.
     * @type {RefundReasonEnum}
     * @memberof CreateRefundRequest
     */
    reason?: RefundReasonEnum;
    /**
     * The charge was refunded by an external platform. This cause the request to not execute a refund externally and instead simply update internal records.
     * @type {boolean}
     * @memberof CreateRefundRequest
     */
    refundedOutOfBand?: boolean;
}
/**
 * Check if a given object implements the CreateRefundRequest interface.
 */
export declare function instanceOfCreateRefundRequest(value: object): value is CreateRefundRequest;
export declare function CreateRefundRequestFromJSON(json: any): CreateRefundRequest;
export declare function CreateRefundRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateRefundRequest;
export declare function CreateRefundRequestToJSON(json: any): CreateRefundRequest;
export declare function CreateRefundRequestToJSONTyped(value?: CreateRefundRequest | null, ignoreDiscriminator?: boolean): any;