Mayson Monorepo Documentation
    Preparing search index...

    Interface OutboundPaymentCreateParams

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

    Properties

    amount currency financial_account customer? description? destination_payment_method? destination_payment_method_data? destination_payment_method_options? end_user_details? 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.

    customer?: string

    ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.

    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 OutboundPayment. Exclusive with destination_payment_method_data.

    destination_payment_method_data?: Stripe.Treasury.OutboundPaymentCreateParams.DestinationPaymentMethodData

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

    destination_payment_method_options?: Stripe.Treasury.OutboundPaymentCreateParams.DestinationPaymentMethodOptions

    Payment method-specific configuration for this OutboundPayment.

    end_user_details?: Stripe.Treasury.OutboundPaymentCreateParams.EndUserDetails

    End user 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

    The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. Can only include -#.$&*, spaces, and alphanumeric characters. The default value is "payment".

    Settings

    Member Visibility

    On This Page

    Properties