Mayson Monorepo Documentation
    Preparing search index...

    Interface PayoutCreateParams

    interface PayoutCreateParams {
        amount: number;
        currency: string;
        description?: string;
        destination?: string;
        expand?: string[];
        metadata?: MetadataParam;
        method?: Method;
        payout_method?: string;
        source_type?: Stripe.PayoutCreateParams.SourceType;
        statement_descriptor?: string;
    }
    Index

    Properties

    amount currency description? destination? expand? metadata? method? payout_method? source_type? statement_descriptor?

    Properties

    amount: number

    A positive integer in cents representing how much to payout.

    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.

    destination?: string

    The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.

    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.

    method?: Method

    The method used to send this payout, which is standard or instant. We support instant for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.

    payout_method?: string

    The ID of a v2 FinancialAccount to send funds to.

    source_type?: Stripe.PayoutCreateParams.SourceType

    The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of bank_account, card, or fpx.

    statement_descriptor?: string

    A string that displays on the recipient's bank or card statement (up to 22 characters). A statement_descriptor that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.

    Settings

    Member Visibility

    On This Page

    Properties