Mayson Monorepo Documentation
    Preparing search index...

    Interface TransferCreateParams

    interface TransferCreateParams {
        currency: string;
        destination: string;
        amount?: number;
        description?: string;
        expand?: string[];
        metadata?: MetadataParam;
        source_transaction?: string;
        source_type?: Stripe.TransferCreateParams.SourceType;
        transfer_group?: string;
    }
    Index

    Properties

    currency destination amount? description? expand? metadata? source_transaction? source_type? transfer_group?

    Properties

    currency: string

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

    destination: string

    The ID of a connected Stripe account. See the Connect documentation for details.

    amount?: number

    A positive integer in cents (or local equivalent) representing how much to transfer.

    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?: 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_transaction?: string

    You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. See the Connect documentation for details.

    source_type?: Stripe.TransferCreateParams.SourceType

    The source balance to use for this transfer. One of bank_account, card, or fpx. For most users, this will default to card.

    transfer_group?: string

    A string that identifies this transaction as part of a group. See the Connect documentation for details.

    Settings

    Member Visibility

    On This Page

    Properties