Mayson Monorepo Documentation
    Preparing search index...

    Interface InboundTransferCreateParams

    interface InboundTransferCreateParams {
        amount: number;
        currency: string;
        financial_account: string;
        origin_payment_method: string;
        description?: string;
        expand?: string[];
        metadata?: MetadataParam;
        statement_descriptor?: string;
    }
    Index

    Properties

    amount currency financial_account origin_payment_method description? 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 send funds to.

    origin_payment_method: string

    The origin payment method to be debited for the InboundTransfer.

    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.

    statement_descriptor?: string

    The complete description that appears on your customers' statements. Maximum 10 characters. Can only include -#.$&*, spaces, and alphanumeric characters.

    Settings

    Member Visibility

    On This Page

    Properties