# The OutboundPayment object

### The OutboundPayment object

```json
{
  "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
}
```

## Attributes

- `id` (string)
  Unique identifier for the OutboundPayment.

- `object` (string, 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.

- [`amount`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=amount&api-version=2025-04-30.preview) (object)
  The “presentment amount” for the OutboundPayment.

- `cancelable` (boolean)
  Returns true if the OutboundPayment can be canceled, and false otherwise.

- `created` (timestamp)
  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_options`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=delivery_options&api-version=2025-04-30.preview) (object, nullable)
  Delivery options to be used to send the OutboundPayment.

- `description` (string, nullable)
  An arbitrary string attached to the OutboundPayment. Often useful for displaying to users.

- `expected_arrival_date` (timestamp, nullable)
  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.

- [`from`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=from&api-version=2025-04-30.preview) (object)
  The FinancialAccount that funds were pulled from.

- `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` (map, nullable)
  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_quote` (string, nullable)
  The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation.

- `receipt_url` (string, nullable)
  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_notification`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=recipient_notification&api-version=2025-04-30.preview) (object)
  Details about the OutboundPayment notification settings for recipient.

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

- `status` (enum)
  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_details`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=status_details&api-version=2025-04-30.preview) (object, nullable)
  Status details for an OutboundPayment in a `failed` or `returned` state.

- [`status_transitions`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=status_transitions&api-version=2025-04-30.preview) (object, nullable)
  Hash containing timestamps of when the object transitioned to a particular status.

- [`to`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=to&api-version=2025-04-30.preview) (object)
  To which payout method the OutboundPayment was sent.

- [`trace_id`](https://docs.stripe.com/api/v2/money-management/outbound-payments/object.md?query=trace_id&api-version=2025-04-30.preview) (object)
  A unique identifier that can be used to track this OutboundPayment with recipient bank. Banks might call this a “reference number” or something similar.
