stripe/cjs/resources/Topups.d.ts

Stripe API wrapper

import { StripeResource } from '../StripeResource.js';
import { BalanceTransaction } from './BalanceTransactions.js';
import { Source } from './Sources.js';
import { Emptyable, MetadataParam, PaginationParams, RangeQueryParam, Metadata } from '../shared.js';
import { RequestOptions, ApiListPromise, Response } from '../lib.js';
export declare class TopupResource extends StripeResource {
    /**
     * Returns a list of top-ups.
     */
    list(params?: TopupListParams, options?: RequestOptions): ApiListPromise<Topup>;
    /**
     * Top up the balance of an account
     */
    create(params: TopupCreateParams, options?: RequestOptions): Promise<Response<Topup>>;
    /**
     * Retrieves the details of a top-up that has previously been created. Supply the unique top-up ID that was returned from your previous request, and Stripe will return the corresponding top-up information.
     */
    retrieve(id: string, params?: TopupRetrieveParams, options?: RequestOptions): Promise<Response<Topup>>;
    /**
     * Updates the metadata of a top-up. Other top-up details are not editable by design.
     */
    update(id: string, params?: TopupUpdateParams, options?: RequestOptions): Promise<Response<Topup>>;
    /**
     * Cancels a top-up. Only pending top-ups can be canceled.
     */
    cancel(id: string, params?: TopupCancelParams, options?: RequestOptions): Promise<Response<Topup>>;
}
export interface Topup {
    /**
     * Unique identifier for the object.
     */
    id: string;
    /**
     * String representing the object's type. Objects of the same type share the same value.
     */
    object: 'topup';
    /**
     * Amount transferred.
     */
    amount: number;
    /**
     * ID of the balance transaction that describes the impact of this top-up on your account balance. May not be specified depending on status of top-up.
     */
    balance_transaction: string | 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://stripe.com/docs/currencies).
     */
    currency: string;
    /**
     * An arbitrary string attached to the object. Often useful for displaying to users.
     */
    description: string | null;
    /**
     * Date the funds are expected to arrive in your Stripe account for payouts. This factors in delays like weekends or bank holidays. May not be specified depending on status of top-up.
     */
    expected_availability_date: number | null;
    /**
     * Error code explaining reason for top-up failure if available (see [the errors section](https://docs.stripe.com/api/errors) for a list of codes).
     */
    failure_code: string | null;
    /**
     * Message to user further explaining reason for top-up failure if available.
     */
    failure_message: string | null;
    /**
     * If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
     */
    livemode: boolean;
    /**
     * Set of [key-value pairs](https://docs.stripe.com/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: Metadata;
    /**
     * The source field is deprecated. It might not always be present in the API response.
     */
    source: Source | null;
    /**
     * Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.
     */
    statement_descriptor: string | null;
    /**
     * The status of the top-up is either `canceled`, `failed`, `pending`, `reversed`, or `succeeded`.
     */
    status: Topup.Status;
    /**
     * A string that identifies this top-up as part of a group.
     */
    transfer_group: string | null;
}
export declare namespace Topup {
    type Status = 'canceled' | 'failed' | 'pending' | 'reversed' | 'succeeded';
}
export interface TopupCreateParams {
    /**
     * A positive integer representing how much to transfer.
     */
    amount: number;
    /**
     * Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
     */
    currency: string;
    /**
     * An arbitrary string attached to the object. Often useful for displaying to users.
     */
    description?: string;
    /**
     * Specifies which fields in the response should be expanded.
     */
    expand?: Array<string>;
    /**
     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
     */
    metadata?: Emptyable<MetadataParam>;
    /**
     * The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](https://docs.stripe.com/connect/testing#testing-top-ups)).
     */
    source?: string;
    /**
     * Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.
     */
    statement_descriptor?: string;
    /**
     * A string that identifies this top-up as part of a group.
     */
    transfer_group?: string;
}
export interface TopupRetrieveParams {
    /**
     * Specifies which fields in the response should be expanded.
     */
    expand?: Array<string>;
}
export interface TopupUpdateParams {
    /**
     * An arbitrary string attached to the object. Often useful for displaying to users.
     */
    description?: string;
    /**
     * Specifies which fields in the response should be expanded.
     */
    expand?: Array<string>;
    /**
     * Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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`.
     */
    metadata?: Emptyable<MetadataParam>;
}
export interface TopupListParams extends PaginationParams {
    /**
     * A positive integer representing how much to transfer.
     */
    amount?: RangeQueryParam | number;
    /**
     * A filter on the list, based on the object `created` field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.
     */
    created?: RangeQueryParam | number;
    /**
     * Specifies which fields in the response should be expanded.
     */
    expand?: Array<string>;
    /**
     * Only return top-ups that have the given status. One of `canceled`, `failed`, `pending` or `succeeded`.
     */
    status?: TopupListParams.Status;
}
export declare namespace TopupListParams {
    type Status = 'canceled' | 'failed' | 'pending' | 'succeeded';
}
export interface TopupCancelParams {
    /**
     * Specifies which fields in the response should be expanded.
     */
    expand?: Array<string>;
}