Mayson Monorepo Documentation
    Preparing search index...

    Interface TransferCreateReversalParams

    interface TransferCreateReversalParams {
        amount?: number;
        description?: string;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
        refund_application_fee?: boolean;
    }
    Index

    Properties

    amount?: number

    A positive integer in cents (or local equivalent) representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.

    description?: string

    An arbitrary string which you can attach to a reversal object. This will be unset if you POST an empty value.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    refund_application_fee?: boolean

    Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.