The Outbound Payment object 

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• amountinteger

  Amount (in cents) transferred.

• cancelableboolean

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

• createdtimestamp

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

• currencyenum

  Three-letter ISO currency code, in lowercase. Must be a supported currency.

• customernullable string

  ID of the customer to whom an OutboundPayment is sent.

• descriptionnullable string

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

• destination_payment_methodnullable 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_detailsnullable object

  Details about the PaymentMethod for an OutboundPayment.

  Hide child attributes

  • destination_payment_method_details.billing_detailsobject

    Contact details for the person or business receiving the OutboundPayment.

    Hide child attributes

    • destination_payment_method_details.billing_details.addressobject

      Billing address.

      Hide child attributes

      • destination_payment_method_details.billing_details.address.citynullable string

        City, district, suburb, town, or village.

      • destination_payment_method_details.billing_details.address.countrynullable string

        Two-letter country code (ISO 3166-1 alpha-2).

      • destination_payment_method_details.billing_details.address.line1nullable string

        Address line 1 (e.g., street, PO Box, or company name).

      • destination_payment_method_details.billing_details.address.line2nullable string

        Address line 2 (e.g., apartment, suite, unit, or building).

      • destination_payment_method_details.billing_details.address.postal_codenullable string

        ZIP or postal code.

      • destination_payment_method_details.billing_details.address.statenullable string

        State, county, province, or region.

    • destination_payment_method_details.billing_details.emailnullable string

      Email address.

    • destination_payment_method_details.billing_details.namenullable string

      Full name.

  • destination_payment_method_details.financial_accountnullable object

    Details about the financial_account.

    Hide child attributes

    • destination_payment_method_details.financial_account.idstring

      Token of the FinancialAccount.

    • destination_payment_method_details.financial_account.networkenum

      The rails used to send funds.

  • destination_payment_method_details.typeenum

    The type of the payment method used in the OutboundPayment.

    Possible enum values

    financial_account

    us_bank_account

  • destination_payment_method_details.us_bank_accountnullable object

    Details about the us_bank_account.

    Hide child attributes

    • destination_payment_method_details.us_bank_account.account_holder_typenullable enum

      Account holder type: individual or company.

      Possible enum values

      company Account belongs to a company

      individual Account belongs to an individual

    • destination_payment_method_details.us_bank_account.account_typenullable enum

      Account type: checkings or savings. Defaults to checking if omitted.

      Possible enum values

      checking Bank account type is checking

      savings Bank account type is savings

    • destination_payment_method_details.us_bank_account.bank_namenullable string

      Name of the bank associated with the bank account.

    • destination_payment_method_details.us_bank_account.fingerprintnullable string

      Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

    • destination_payment_method_details.us_bank_account.last4nullable string

      Last four digits of the bank account number.

    • destination_payment_method_details.us_bank_account.mandatenullable stringExpandable

      ID of the mandate used to make this payment.

    • destination_payment_method_details.us_bank_account.networkenum

      The network rails used. See the docs to learn more about money movement timelines for each network type.

      Possible enum values

      ach ACH network

      us_domestic_wire US domestic wire network

    • destination_payment_method_details.us_bank_account.routing_numbernullable string

      Routing number of the bank account.

• end_user_detailsnullable object

  Details about the end user.

  Hide child attributes

  • end_user_details.ip_addressnullable string

    IP address of the user initiating the OutboundPayment. Set if present is set to true. IP address collection is required for risk and compliance reasons. This will be used to help determine if the OutboundPayment is authorized or should be blocked.

  • end_user_details.presentboolean

    true if the OutboundPayment creation request is being made on behalf of an end user by a platform. Otherwise, false.

• expected_arrival_datetimestamp

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

• financial_accountstring

  The FinancialAccount that funds were pulled from.

• hosted_regulatory_receipt_urlnullable string

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

• livemodeboolean

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

• metadataobject

  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_detailsnullable object

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

  Hide child attributes

  • returned_details.codeenum

    Reason for the return.

    Possible enum values

    account_closed The destination has been closed.

    account_frozen The destination has been frozen.

    bank_account_restricted The destination bank account has restrictions on either the type or number of transfers allowed. This normally indicates that the bank account is a savings or other non-checking account.

    bank_ownership_changed The destination bank account is no longer valid because its branch has changed ownership.

    declined The destination has declined this OutboundPayment.

    incorrect_account_holder_name The destination bank notified us that the bank account holder name on file is incorrect.

    invalid_account_number The destination bank account details on file are probably incorrect. The routing number seems correct, but the account number is invalid.

    invalid_currency The destination was unable to process this OutboundPayment because of its currency.

    no_account The destination bank account details on file are probably incorrect. No bank account exists with these details.

    other The destination could not process this OutboundPayment.

  • returned_details.transactionstringExpandable

    The Transaction associated with this object.

• statement_descriptorstring

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

• statusenum

  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_transitionsobject

  Hash containing timestamps of when the object transitioned to a particular status.

  Hide child attributes

  • status_transitions.canceled_atnullable timestamp

    Timestamp describing when an OutboundPayment changed status to canceled.

  • status_transitions.failed_atnullable timestamp

    Timestamp describing when an OutboundPayment changed status to failed.

  • status_transitions.posted_atnullable timestamp

    Timestamp describing when an OutboundPayment changed status to posted.

  • status_transitions.returned_atnullable timestamp

    Timestamp describing when an OutboundPayment changed status to returned.

• tracking_detailsnullable object

  Details about network-specific tracking information if available.

  Hide child attributes

  • tracking_details.achnullable object

    ACH network tracking details.

    Hide child attributes

    • tracking_details.ach.trace_idstring

      ACH trace ID of the OutboundPayment for payments sent over the ach network.

  • tracking_details.typeenum

    The US bank account network used to send funds.

    Possible enum values

    ach

    us_domestic_wire

  • tracking_details.us_domestic_wirenullable object

    US domestic wire network tracking details.

    Hide child attributes

    • tracking_details.us_domestic_wire.chipsnullable string

      CHIPS System Sequence Number (SSN) of the OutboundPayment for payments sent over the us_domestic_wire network.

    • tracking_details.us_domestic_wire.imadnullable string

      IMAD of the OutboundPayment for payments sent over the us_domestic_wire network.

    • tracking_details.us_domestic_wire.omadnullable string

      OMAD of the OutboundPayment for payments sent over the us_domestic_wire network.

• transactionstringExpandable

  The Transaction associated with this object.