Mayson Monorepo Documentation
    Preparing search index...

    Interface OutboundTransferCreateParams

    interface OutboundTransferCreateParams {
        amount: number;
        currency: string;
        financial_account: string;
        description?: string;
        destination_payment_method?: string;
        destination_payment_method_data?: Stripe.Treasury.OutboundTransferCreateParams.DestinationPaymentMethodData;
        destination_payment_method_options?: Stripe.Treasury.OutboundTransferCreateParams.DestinationPaymentMethodOptions;
        expand?: string[];
        metadata?: MetadataParam;
        statement_descriptor?: string;
    }
    Index

    Properties

    amount currency financial_account description? destination_payment_method? destination_payment_method_data? destination_payment_method_options? expand? metadata? statement_descriptor?

    Properties

    amount: number

    Amount (in cents) to be transferred.

    currency: string

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

    financial_account: string

    The FinancialAccount to pull funds from.

    description?: string

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

    destination_payment_method?: string

    The PaymentMethod to use as the payment instrument for the OutboundTransfer.

    destination_payment_method_data?: Stripe.Treasury.OutboundTransferCreateParams.DestinationPaymentMethodData

    Hash used to generate the PaymentMethod to be used for this OutboundTransfer. Exclusive with destination_payment_method.

    destination_payment_method_options?: Stripe.Treasury.OutboundTransferCreateParams.DestinationPaymentMethodOptions

    Hash describing payment method configuration details.

    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.

    statement_descriptor?: string

    Statement descriptor to be shown on the receiving end of an OutboundTransfer. Maximum 10 characters for ach transfers or 140 characters for us_domestic_wire transfers. The default value is "transfer". Can only include -#.$&*, spaces, and alphanumeric characters.

    Settings

    Member Visibility

    On This Page

    Properties