Mayson Monorepo Documentation
    Preparing search index...

    Interface OutboundPayment

    Use OutboundPayments to send funds to another party's external bank account or FinancialAccount. To send money to an account belonging to the same user, use an OutboundTransfer.

    Simulate OutboundPayment state changes with the /v1/test_helpers/treasury/outbound_payments endpoints. These methods can only be called on test mode objects.

    Related guide: Moving money with Treasury using OutboundPayment objects

    interface OutboundPayment {
        id: string;
        object: "treasury.outbound_payment";
        amount: number;
        cancelable: boolean;
        created: number;
        currency: string;
        customer: string;
        description: string;
        destination_payment_method: string;
        destination_payment_method_details: Stripe.Treasury.OutboundPayment.DestinationPaymentMethodDetails;
        end_user_details: Stripe.Treasury.OutboundPayment.EndUserDetails;
        expected_arrival_date: number;
        financial_account: string;
        hosted_regulatory_receipt_url: string;
        livemode: boolean;
        metadata: Metadata;
        returned_details: Stripe.Treasury.OutboundPayment.ReturnedDetails;
        statement_descriptor: string;
        status: Stripe.Treasury.OutboundPayment.Status;
        status_transitions: Stripe.Treasury.OutboundPayment.StatusTransitions;
        tracking_details: Stripe.Treasury.OutboundPayment.TrackingDetails;
        transaction: string | Stripe.Treasury.Transaction;
    }
    Index

    Properties

    id object amount cancelable created currency customer description destination_payment_method destination_payment_method_details end_user_details expected_arrival_date financial_account hosted_regulatory_receipt_url livemode metadata returned_details statement_descriptor status status_transitions tracking_details transaction

    Properties

    id: string

    Unique identifier for the object.

    object: "treasury.outbound_payment"

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

    amount: number

    Amount (in cents) transferred.

    cancelable: boolean

    Returns true if the object can be canceled, and false otherwise.

    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.

    customer: string

    ID of the customer to whom an OutboundPayment is sent.

    description: string

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

    destination_payment_method: string

    The PaymentMethod via which an OutboundPayment is sent. This field can be empty if the OutboundPayment was created using destination_payment_method_data.

    destination_payment_method_details: Stripe.Treasury.OutboundPayment.DestinationPaymentMethodDetails

    Details about the PaymentMethod for an OutboundPayment.

    end_user_details: Stripe.Treasury.OutboundPayment.EndUserDetails

    Details about the end user.

    expected_arrival_date: number

    The date when funds are expected to arrive in the destination account.

    financial_account: string

    The FinancialAccount that funds were pulled from.

    hosted_regulatory_receipt_url: string

    A hosted transaction receipt URL that is provided when money movement is considered regulated under Stripe's money transmission licenses.

    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.

    returned_details: Stripe.Treasury.OutboundPayment.ReturnedDetails

    Details about a returned OutboundPayment. Only set when the status is returned.

    statement_descriptor: string

    The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer).

    status: Stripe.Treasury.OutboundPayment.Status

    Current status of the OutboundPayment: processing, failed, posted, returned, canceled. An OutboundPayment is processing if it has been created and is pending. The status changes to posted once the OutboundPayment has been "confirmed" and funds have left the account, or to failed or canceled. If an OutboundPayment fails to arrive at its destination, its status will change to returned.

    status_transitions: Stripe.Treasury.OutboundPayment.StatusTransitions
    tracking_details: Stripe.Treasury.OutboundPayment.TrackingDetails

    Details about network-specific tracking information if available.

    transaction: string | Stripe.Treasury.Transaction

    The Transaction associated with this object.

    Settings

    Member Visibility

    On This Page

    Properties