expresspayments/types/Balance.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        /**
         * This is an object representing your ExpressPayments balance. You can retrieve it to see
         * the balance currently on your ExpressPayments account.
         *
         * You can also retrieve the balance history, which contains a list of
         * [transactions](https://docs.epayments.network/reporting/balance-transaction-types) that contributed to the balance
         * (charges, payouts, and so forth).
         *
         * The available and pending amounts for each currency are broken down further by
         * payment source types.
         *
         * Related guide: [Understanding Connect account balances](https://docs.epayments.network/connect/account-balances)
         */
        interface Balance {
            /**
             * String representing the object's type. Objects of the same type share the same value.
             */
            object: 'balance';

            /**
             * Funds that are available to be transferred or paid out, whether automatically by ExpressPayments or explicitly via the [Transfers API](https://docs.epayments.network/api#transfers) or [Payouts API](https://docs.epayments.network/api#payouts). The available balance for each currency and payment type can be found in the `source_types` property.
             */
            available: Array<Balance.Available>;

            /**
             * Funds held due to negative balances on connected Custom accounts. The connect reserve balance for each currency and payment type can be found in the `source_types` property.
             */
            connect_reserved?: Array<Balance.ConnectReserved>;

            /**
             * Funds that can be paid out using Instant Payouts.
             */
            instant_available?: Array<Balance.InstantAvailable>;

            issuing?: Balance.Issuing;

            /**
             * Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
             */
            livemode: boolean;

            /**
             * Funds that are not yet available in the balance, due to the 7-day rolling pay cycle. The pending balance for each currency, and for each payment type, can be found in the `source_types` property.
             */
            pending: Array<Balance.Pending>;
        }

        namespace Balance {
            interface Available {
                /**
                 * Balance amount.
                 */
                amount: 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;

                source_types?: Available.SourceTypes;
            }

            namespace Available {
                interface SourceTypes {
                    /**
                     * Amount for bank account.
                     */
                    bank_account?: number;

                    /**
                     * Amount for card.
                     */
                    card?: number;

                    /**
                     * Amount for FPX.
                     */
                    fpx?: number;
                }
            }

            interface ConnectReserved {
                /**
                 * Balance amount.
                 */
                amount: 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;

                source_types?: ConnectReserved.SourceTypes;
            }

            namespace ConnectReserved {
                interface SourceTypes {
                    /**
                     * Amount for bank account.
                     */
                    bank_account?: number;

                    /**
                     * Amount for card.
                     */
                    card?: number;

                    /**
                     * Amount for FPX.
                     */
                    fpx?: number;
                }
            }

            interface InstantAvailable {
                /**
                 * Balance amount.
                 */
                amount: 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;

                source_types?: InstantAvailable.SourceTypes;
            }

            namespace InstantAvailable {
                interface SourceTypes {
                    /**
                     * Amount for bank account.
                     */
                    bank_account?: number;

                    /**
                     * Amount for card.
                     */
                    card?: number;

                    /**
                     * Amount for FPX.
                     */
                    fpx?: number;
                }
            }

            interface Issuing {
                /**
                 * Funds that are available for use.
                 */
                available: Array<Issuing.Available>;
            }

            namespace Issuing {
                interface Available {
                    /**
                     * Balance amount.
                     */
                    amount: 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;

                    source_types?: Available.SourceTypes;
                }

                namespace Available {
                    interface SourceTypes {
                        /**
                         * Amount for bank account.
                         */
                        bank_account?: number;

                        /**
                         * Amount for card.
                         */
                        card?: number;

                        /**
                         * Amount for FPX.
                         */
                        fpx?: number;
                    }
                }
            }

            interface Pending {
                /**
                 * Balance amount.
                 */
                amount: 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;

                source_types?: Pending.SourceTypes;
            }

            namespace Pending {
                interface SourceTypes {
                    /**
                     * Amount for bank account.
                     */
                    bank_account?: number;

                    /**
                     * Amount for card.
                     */
                    card?: number;

                    /**
                     * Amount for FPX.
                     */
                    fpx?: number;
                }
            }
        }
    }
}