Mayson Monorepo Documentation
    Preparing search index...

    Interface TopupCreateParams

    interface TopupCreateParams {
        amount: number;
        currency: string;
        description?: string;
        expand?: string[];
        metadata?: Emptyable<MetadataParam>;
        source?: string;
        statement_descriptor?: string;
        transfer_group?: string;
    }
    Index

    Properties

    amount currency description? expand? metadata? source? statement_descriptor? transfer_group?

    Properties

    amount: number

    A positive integer representing how much to transfer.

    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.

    expand?: string[]

    Specifies which fields in the response should be expanded.

    metadata?: Emptyable<MetadataParam>

    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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    source?: string

    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).

    statement_descriptor?: string

    Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.

    transfer_group?: string

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

    Settings

    Member Visibility

    On This Page

    Properties