expresspayments/types/TransferReversals.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        /**
         * [ExpressPayments Connect](https://docs.epayments.network/connect) platforms can reverse transfers made to a
         * connected account, either entirely or partially, and can also specify whether
         * to refund any related application fees. Transfer reversals add to the
         * platform's balance and subtract from the destination account's balance.
         *
         * Reversing a transfer that was made for a [destination
         * charge](https://docs.epayments.network/connect/destination-charges) is allowed only up to the amount of
         * the charge. It is possible to reverse a
         * [transfer_group](https://docs.epayments.network/connect/charges-transfers#transfer-options)
         * transfer only if the destination account has enough balance to cover the
         * reversal.
         *
         * Related guide: [Reversing transfers](https://docs.epayments.network/connect/charges-transfers#reversing-transfers)
         */
        interface TransferReversal {
            /**
             * Unique identifier for the object.
             */
            id: string;

            /**
             * String representing the object's type. Objects of the same type share the same value.
             */
            object: 'transfer_reversal';

            /**
             * Amount, in %s.
             */
            amount: number;

            /**
             * Balance transaction that describes the impact on your account balance.
             */
            balance_transaction:
                | string
                | ExpressPayments.BalanceTransaction
                | null;

            /**
             * Time at which the object was created. Measured in seconds since the Unix epoch.
             */
            created: number;

            /**
             * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
             */
            currency: string;

            /**
             * Linked payment refund for the transfer reversal.
             */
            destination_payment_refund: string | ExpressPayments.Refund | null;

            /**
             * Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
             */
            metadata: ExpressPayments.Metadata | null;

            /**
             * ID of the refund responsible for the transfer reversal.
             */
            source_refund: string | ExpressPayments.Refund | null;

            /**
             * ID of the transfer that was reversed.
             */
            transfer: string | ExpressPayments.Transfer;
        }
    }
}