The OutboundPayment object

Money Management

Outbound Payments

Attributes

idstring
Unique identifier for the OutboundPayment.

objectstring, value is "v2.money_management.outbound_payment"
String representing the object’s type. Objects of the same type share the same value of the object field.

amountobject
The “presentment amount” for the OutboundPayment.
- amount.currencystring
  A lowercase alpha3 currency code like “usd”.
- amount.valueinteger
  In minor units like 123 for 1.23 USD.

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

createdtimestamp
Time at which the OutboundPayment was created. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

delivery_optionsnullable object
Delivery options to be used to send the OutboundPayment.
- delivery_options.bank_accountnullable enum
  Method for bank account.
  Possible enum values
  automatic
  Method automatically selected by Stripe.
  local
  The group of local bank-transfer networks in the bank account’s country.
  wire
  The group of wire transfer networks in the bank account’s country.

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

expected_arrival_datenullable timestamp
The date when funds are expected to arrive in the payout method. This field is not set if the payout method is in a failed, canceled, or returned state. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

fromobject
The FinancialAccount that funds were pulled from.
- from.debitedobject
  The monetary amount debited from the sender, only set on responses.
  from.debited.currencystring
  A lowercase alpha3 currency code like “usd”.
  from.debited.valueinteger
  In minor units like 123 for 1.23 USD.
- from.financial_accountstring
  The FinancialAccount that funds were pulled from.

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

metadatanullable map
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.

outbound_payment_quotenullable stringPreview feature
The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.

receipt_urlnullable string
A link to the Stripe-hosted receipt for this OutboundPayment. The receipt link remains active for 60 days from the OutboundPayment creation date. After this period, the link will expire and the receipt url value will be null.

recipient_notificationobject
Details about the OutboundPayment notification settings for recipient.
- recipient_notification.settingenum
  Configuration option to enable or disable notifications to recipients. Do not send notifications when setting is NONE. Default to account setting when setting is CONFIGURED or not set.
  Possible enum values
  configured
  Default to account setting.
  none
  Do not send email.

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 processing. 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 payout method, its status will change to returned.

Possible enum values

canceled

A user canceled the OutboundPayment before posting. Stripe returns the funds to the user by voiding the pending Transaction.

failed

The OutboundPayment failed to confirm. Stripe returns the funds to the user by voiding the pending Transaction.

posted

The OutboundPayment posted and funds have left the account. The underlying Transaction posts.

processing

The OutboundPayment starting state. Funds are “held” by a pending Transaction (but are still part of the current balance). The OutboundPayment might be cancelable by the user, depending on the value of the cancelable field.

returned

The OutboundPayment failed to successfully arrive at the destination. Funds return to the user with a second posted Transaction attached to the same flow.

status_detailsnullable object

Status details for an OutboundPayment in a failed or returned state.

status_details.failednullable object

The failed status reason.

status_details.failed.reasonenum

The failed status reason.

Possible enum values

payout_method_declined

The outbound flow to this payout method was declined.

payout_method_does_not_exist

Payout method used for this outbound flow does not exist.

payout_method_expired

Payout method used for this outbound flow expired.

payout_method_unsupported

Payout method used for this outbound flow is unsupported.

payout_method_usage_frequency_limit_exceeded

The usage frequency limit for this payout method was exceeded.

unknown_failure

Unknown failure.

status_details.returnednullable object

The returned status reason.

status_details.returned.reasonenum

The returned status reason.

Possible enum values

payout_method_canceled_by_customer

The outbound flow to this payout method was canceled by customer.

payout_method_closed

Payout method account used for this outbound flow is closed.

payout_method_currency_unsupported

Currency is not supported by the payout method account.

payout_method_does_not_exist

Payout method account used for this outbound flow does not exist.

payout_method_holder_address_incorrect

Address on the payout method account is incorrect.

payout_method_holder_details_incorrect

The payout method account holder’s details are incorrect.

payout_method_holder_name_incorrect

Name on the payout method account is incorrect.

payout_method_invalid_account_number

The outbound flow to this payout method has an invalid account number.

payout_method_restricted

Payout method account used for this outbound flow is restricted.

recalled

The outbound flow to this payout method was recalled.

Show 1 more

status_transitionsnullable object
Hash containing timestamps of when the object transitioned to a particular status.
- status_transitions.canceled_atnullable timestamp
  Timestamp describing when an OutboundPayment changed status to canceled. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- status_transitions.failed_atnullable timestamp
  Timestamp describing when an OutboundPayment changed status to failed. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- status_transitions.posted_atnullable timestamp
  Timestamp describing when an OutboundPayment changed status to posted. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.
- status_transitions.returned_atnullable timestamp
  Timestamp describing when an OutboundPayment changed status to returned. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z.

toobject
To which payout method the OutboundPayment was sent.
- to.creditedobject
  The monetary amount being credited to the destination.
  to.credited.currencystring
  A lowercase alpha3 currency code like “usd”.
  to.credited.valueinteger
  In minor units like 123 for 1.23 USD.
- to.payout_methodstring
  The payout method which the OutboundPayment uses to send payout.
- to.recipientstring
  To which account the OutboundPayment is sent.

trace_idobjectPreview feature
A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
- trace_id.statusenum
  Possible values are pending, supported, and unsupported. Initially set to pending, it changes to supported when the recipient bank provides a trace ID, or unsupported if the recipient bank doesn’t support it. Note that this status may not align with the OutboundPayment or OutboundTransfer status and can remain pending even after the payment or transfer is posted.
  Possible enum values
  pending
  Pending to receive TraceId information from recipient bank.
  supported
  TraceId is supported by the recipient bank.
  unsupported
  TraceId is not supported by the recipient bank.
- trace_id.valuenullable string
  The trace ID value if trace_id.status is supported, otherwise empty.

The OutboundPayment object

{
  "id": "obp_test_65OAfT9tVl3u223h0he16NybHIZ4SQ3LORe4rpuNGDIKCO",
  "object": "v2.money_management.outbound_payment",
  "from": {
    "financial_account": "fa_test_65NybHaQx7KJxDc22rZ16NybHIZ4SQ3LORe4rpuNGDIXEO",
    "debited": {
      "value": 1000,
      "currency": "usd"
    }
  },
  "to": {
    "credited": {
      "value": 1000,
      "currency": "usd"
    },
    "recipient": "acct_test_61Nyc6oHjbwlpjhvd66Nyc6oZ4SQv89ZZAqvHiCECJ3g",
    "payout_method": "usba_test_61Nyd9YFBVUzLyxXZ16Nyc6oZ4SQv89ZZAqvHiCEC9VQ"
  },
  "delivery_options": {
    "bank_account": "automatic"
  },
  "amount": {
    "value": 1000,
    "currency": "usd"
  },
  "statement_descriptor": "Payment for streaming earnings",
  "cancelable": true,
  "description": "Streamer earnings",
  "status": "processing",
  "status_transitions": {},
  "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZOeWJISVo0U1EzTE9SZTRycHVOR0RJKMPgpqIGMgbztcBwNg46oQGUmYI69-O84chYtSQDFeO22gsaZPBsi9OkhxmOvY_z5ElXLqPGy_WUkLZ0XuCmjerVOR-ZnrOKDcHldqWvsxHXRaRnjq2SLu5V7tJaYWNe3_Vy2VhWmJ8H09qAOl8HxjS9prFckpisbEa_1u53hKgIXZVoI4FEOVWgFcf0-d7ev6zL728kPw-QcXbRkPi-wwaIXwxRNbyTpsBi6KzQ7PTqlg",
  "created": "2023-04-26T23:12:35.952Z",
  "expected_arrival_date": "2023-04-28T00:00:00Z",
  "recipient_notification": {
    "setting": "configured"
  },
  "trace_id": {
    "status": "pending",
    "value": ""
  },
  "outbound_payment_quote": null
}

The OutboundPayment object

Attributes

idstring

objectstring, value is "v2.money_management.outbound_payment"

amountobject

amount.currencystring

amount.valueinteger

cancelableboolean

createdtimestamp

delivery_optionsnullable object

delivery_options.bank_accountnullable enum

descriptionnullable string

expected_arrival_datenullable timestamp

fromobject

from.debitedobject

from.debited.currencystring

from.debited.valueinteger

from.financial_accountstring

livemodeboolean

metadatanullable map

outbound_payment_quotenullable stringPreview feature

receipt_urlnullable string

recipient_notificationobject

recipient_notification.settingenum

statement_descriptorstring

statusenum

status_detailsnullable object

status_details.failednullable object

status_details.failed.reasonenum

status_details.returnednullable object

status_details.returned.reasonenum

status_transitionsnullable object

status_transitions.canceled_atnullable timestamp

status_transitions.failed_atnullable timestamp

status_transitions.posted_atnullable timestamp

status_transitions.returned_atnullable timestamp

toobject

to.creditedobject

to.credited.currencystring

to.credited.valueinteger

to.payout_methodstring

to.recipientstring

trace_idobjectPreview feature

trace_id.statusenum

trace_id.valuenullable string