expresspayments/types/TestHelpers/CustomersResource.d.ts

ExpressPayments API wrapper

// File generated from our OpenAPI spec

declare module 'expresspayments' {
    namespace ExpressPayments {
        namespace TestHelpers {
            interface CustomerFundCashBalanceParams {
                /**
                 * Amount to be used for this test cash balance transaction. A positive integer representing how much to fund in the [smallest currency unit](https://docs.epayments.network/currencies#zero-decimal) (e.g., 100 cents to fund $1.00 or 100 to fund ¥100, a zero-decimal currency).
                 */
                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;

                /**
                 * Specifies which fields in the response should be expanded.
                 */
                expand?: Array<string>;

                /**
                 * A description of the test funding. This simulates free-text references supplied by customers when making bank transfers to their cash balance. You can use this to test how ExpressPayments' [reconciliation algorithm](https://docs.epayments.network/payments/customer-balance/reconciliation) applies to different user inputs.
                 */
                reference?: string;
            }

            class CustomersResource {
                /**
                 * Create an incoming testmode bank transfer
                 */
                fundCashBalance(
                    id: string,
                    params: CustomerFundCashBalanceParams,
                    options?: RequestOptions
                ): Promise<
                    ExpressPayments.Response<
                        ExpressPayments.CustomerCashBalanceTransaction
                    >
                >;
            }
        }
    }
}