Mayson Monorepo Documentation
    Preparing search index...

    Interface Payout

    A Payout object is created when you receive funds from Stripe, or when you initiate a payout to either a bank account or debit card of a connected Stripe account. You can retrieve individual payouts, and list all payouts. Payouts are made on varying schedules, depending on your country and industry.

    Related guide: Receiving payouts

    interface Payout {
        id: string;
        object: "payout";
        amount: number;
        application_fee: string | Stripe.ApplicationFee;
        application_fee_amount: number;
        arrival_date: number;
        automatic: boolean;
        balance_transaction: string | Stripe.BalanceTransaction;
        created: number;
        currency: string;
        description: string;
        destination: string | Stripe.ExternalAccount | DeletedExternalAccount;
        failure_balance_transaction: string | Stripe.BalanceTransaction;
        failure_code: string;
        failure_message: string;
        livemode: boolean;
        metadata: Metadata;
        method: string;
        original_payout: string | Stripe.Payout;
        payout_method: string;
        reconciliation_status: ReconciliationStatus;
        reversed_by: string | Stripe.Payout;
        source_type: string;
        statement_descriptor: string;
        status: string;
        trace_id: TraceId;
        type: Stripe.Payout.Type;
    }
    Index

    Properties

    id object amount application_fee application_fee_amount arrival_date automatic balance_transaction created currency description destination failure_balance_transaction failure_code failure_message livemode metadata method original_payout payout_method reconciliation_status reversed_by source_type statement_descriptor status trace_id type

    Properties

    id: string

    Unique identifier for the object.

    object: "payout"

    String representing the object's type. Objects of the same type share the same value.

    amount: number

    The amount (in cents (or local equivalent)) that transfers to your bank account or debit card.

    application_fee: string | Stripe.ApplicationFee

    The application fee (if any) for the payout. See the Connect documentation for details.

    application_fee_amount: number

    The amount of the application fee (if any) requested for the payout. See the Connect documentation for details.

    arrival_date: number

    Date that you can expect the payout to arrive in the bank. This factors in delays to account for weekends or bank holidays.

    automatic: boolean

    Returns true if the payout is created by an automated payout schedule and false if it's requested manually.

    balance_transaction: string | Stripe.BalanceTransaction

    ID of the balance transaction that describes the impact of this payout on your account balance.

    created: number

    Time at which the object was created. Measured in seconds since the Unix epoch.

    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 | Stripe.ExternalAccount | DeletedExternalAccount

    ID of the bank account or card the payout is sent to.

    failure_balance_transaction: string | Stripe.BalanceTransaction

    If the payout fails or cancels, this is the ID of the balance transaction that reverses the initial balance transaction and returns the funds from the failed payout back in your balance.

    failure_code: string

    Error code that provides a reason for a payout failure, if available. View our list of failure codes.

    failure_message: string

    Message that provides the reason for a payout failure, if available.

    livemode: boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    metadata: Metadata

    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.

    method: string

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

    original_payout: string | Stripe.Payout

    If the payout reverses another, this is the ID of the original payout.

    payout_method: string

    ID of the v2 FinancialAccount the funds are sent to.

    reconciliation_status: ReconciliationStatus

    If completed, you can use the Balance Transactions API to list all balance transactions that are paid out in this payout.

    reversed_by: string | Stripe.Payout

    If the payout reverses, this is the ID of the payout that reverses this payout.

    source_type: string

    The source balance this payout came from, which can be one of the following: card, fpx, or bank_account.

    statement_descriptor: string

    Extra information about a payout that displays on the user's bank statement.

    status: string

    Current status of the payout: paid, pending, in_transit, canceled or failed. A payout is pending until it's submitted to the bank, when it becomes in_transit. The status changes to paid if the transaction succeeds, or to failed or canceled (within 5 business days). Some payouts that fail might initially show as paid, then change to failed.

    trace_id: TraceId

    A value that generates from the beneficiary's bank that allows users to track payouts with their bank. Banks might call this a "reference number" or something similar.

    type: Stripe.Payout.Type

    Can be bank_account or card.

    Settings

    Member Visibility

    On This Page

    Properties