Mayson Monorepo Documentation
    Preparing search index...

    To top up your Stripe balance, you create a top-up object. You can retrieve individual top-ups, as well as list all top-ups. Top-ups are identified by a unique, random ID.

    Related guide: Topping up your platform account

    interface Topup {
        id: string;
        object: "topup";
        amount: number;
        balance_transaction: string | Stripe.BalanceTransaction;
        created: number;
        currency: string;
        description: string;
        expected_availability_date: number;
        failure_code: string;
        failure_message: string;
        livemode: boolean;
        metadata: Metadata;
        source: Stripe.Source;
        statement_descriptor: string;
        status: Stripe.Topup.Status;
        transfer_group: string;
    }
    Index

    Properties

    id: string

    Unique identifier for the object.

    object: "topup"

    String representing the object's type. Objects of the same type share the same value.

    amount: number

    Amount transferred.

    balance_transaction: string | Stripe.BalanceTransaction

    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.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    currency: string

    Three-letter ISO currency code, in lowercase. Must be a supported currency.

    description: string

    An arbitrary string attached to the object. Often useful for displaying to users.

    expected_availability_date: number

    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.

    failure_code: string

    Error code explaining reason for top-up failure if available (see the errors section for a list of codes).

    failure_message: string

    Message to user further explaining reason for top-up failure if available.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

    source: Stripe.Source

    The source field is deprecated. It might not always be present in the API response.

    statement_descriptor: string

    Extra information about a top-up. This will appear on your source's bank statement. It must contain at least one letter.

    The status of the top-up is either canceled, failed, pending, reversed, or succeeded.

    transfer_group: string

    A string that identifies this top-up as part of a group.