# Create an Outbound Payment Creates an OutboundPayment. ## Parameters - `amount` (object, required) The “presentment amount” to be sent to the recipient. - `amount.currency` (enum, required) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies.md). - `amount.value` (integer, required) A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies.md#minor-units). - `from` (object, required) From which FinancialAccount and BalanceType to pull funds from. - `from.currency` (string, required) Describes the FinancialAmount’s currency drawn from. - `from.financial_account` (string, required) The FinancialAccount that funds were pulled from. - `to` (object, required) To which payout method to send the OutboundPayment. - `to.recipient` (string, required) To which account the OutboundPayment is sent. - `to.currency` (string, optional) Describes the currency to send to the recipient. If included, this currency must match a currency supported by the destination. Can be omitted in the following cases: - destination only supports one currency - destination supports multiple currencies and one of the currencies matches the FA currency - destination supports multiple currencies and one of the currencies matches the presentment currency Note - when both FA currency and presentment currency are supported, we pick the FA currency to minimize FX. - `to.payout_method` (string, optional) The payout method which the OutboundPayment uses to send payout. - `delivery_options` (object, optional) Delivery options to be used to send the OutboundPayment. - `delivery_options.bank_account` (enum, optional) 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. - `description` (string, optional) An arbitrary string attached to the OutboundPayment. Often useful for displaying to users. - `metadata` (map, optional) 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, optional) The quote for this OutboundPayment. Only required for countries with regulatory mandates to display fee estimates before OutboundPayment creation. - `purpose` (enum, optional) The purpose of the OutboundPayment. Possible enum values: - `payroll` The OutboundPayment is for payroll. - `recipient_notification` (object, optional) Details about the notification settings for the OutboundPayment recipient. - `recipient_notification.setting` (enum, required) 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. ## Returns ## Response 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` (object) The “presentment amount” for the OutboundPayment. - `amount.currency` (enum) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies.md). - `amount.value` (integer) A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies.md#minor-units). - `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` (object, nullable) Delivery options to be used to send the OutboundPayment. - `delivery_options.bank_account` (enum, nullable) 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. - `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` (object) The FinancialAccount that funds were pulled from. - `from.debited` (object) The monetary amount debited from the sender, only set on responses. - `from.debited.currency` (enum) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies.md). - `from.debited.value` (integer) A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies.md#minor-units). - `from.financial_account` (string) 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. - `purpose` (enum, nullable) The purpose of the OutboundPayment. Possible enum values: - `payroll` The OutboundPayment is for payroll. - `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` (object) Details about the OutboundPayment notification settings for recipient. - `recipient_notification.setting` (enum) 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_descriptor` (string) The description that appears on the receiving end for an OutboundPayment (for example, bank statement for external bank transfer). It will default to `STRIPE` if not set on the account settings. - `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` (object, nullable) Status details for an OutboundPayment in a `failed` or `returned` state. - `status_details.failed` (object, nullable) The `failed` status reason. - `status_details.failed.reason` (enum) 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.returned` (object, nullable) The `returned` status reason. - `status_details.returned.reason` (enum) 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. - `unknown_failure` Unknown failure. - `status_transitions` (object, nullable) Hash containing timestamps of when the object transitioned to a particular status. - `status_transitions.canceled_at` (timestamp, nullable) 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_at` (timestamp, nullable) 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_at` (timestamp, nullable) 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_at` (timestamp, nullable) 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. - `to` (object) To which payout method the OutboundPayment was sent. - `to.credited` (object) The monetary amount being credited to the destination. - `to.credited.currency` (enum) Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.stripe.com/currencies.md). - `to.credited.value` (integer) A non-negative integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies.md#minor-units). - `to.payout_method` (string) The payout method which the OutboundPayment uses to send payout. - `to.recipient` (string) To which account the OutboundPayment is sent. - `trace_id` (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. - `trace_id.status` (enum) 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.value` (string, nullable) The trace ID value if `trace_id.status` is `supported`, otherwise empty. ## Error Codes | HTTP status code | Code | Description | | ---------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 400 | account_not_configured_as_recipient | Error returned when the recipient account in the OutboundPayment request is not configured as a recipient. | | 400 | amount_too_large_for_payout_method | Error returned when the specified amount exceeds the payout method’s amount limits. | | 400 | amount_too_large_for_selected_delivery_option | Error returned when user selected a delivery option but the specified amount exceeds the method limits. | | 400 | card_payout_method_not_supported | Error returned when the provided Card payout method is not eligible for outbound payment or outbound transfer. | | 400 | cop_not_accepted | Error returned when the Confirmation of Payee is not accepted. | | 400 | default_payout_method_config_not_found | Error returned when a payout method is not provided in the OutboundPayment request and the recipient account does not have a default payout method. | | 400 | delivery_option_not_available | Error returned when real time rails are undergoing downtime. | | 400 | delivery_option_not_supported | Error returned when the selected delivery option is not supported for the payout method. | | 400 | financial_account_operation_unsupported_for_property | Operation not supported on Financial Accounts with this type and property. | | 400 | financial_address_creation_required | Error returned when there is no active financial address required for GB and EU OBPs or OBTs. | | 400 | from_balance_unsupported_currency | Error returned when the balance type in the OutboundPayment/OutboundTransfer request does not support the provided currency. | | 400 | fx_quote_expired | Error returned when rate locking in the used OBPQ is expired. | | 400 | incompatible_delivery_options | Error returned when the delivery option type and speed chosen is incompatible. | | 400 | insufficient_funds | Error returned when the balance of provided financial account and balance type in the OutboundPayment/OutboundTransfer request does not have enough funds. | | 400 | invalid_payout_method_country | Error returned when the payout method country does not match the recipient account country. | | 400 | large_rate_drift | Error returned when the FX rate drift beyond threshold. | | 400 | no_suitable_delivery_options_for_large_amount | Error returned when user does not specify the delivery option or provides automatic, and the amount exceeds all the possible delivery options for this payout method. | | 400 | outbound_flow_from_closed_financial_account_unsupported | The user attempts to create an outbound flow from a closed Financial Account. | | 400 | outbound_payment_ineligible_recipient_address | Error returned when the recipient’s address is invalid. | | 400 | outbound_payment_invalid_paper_check_signature | Error returned when the paper check signature is invalid. | | 400 | outbound_payment_memo_restricted_term | Error returned when the paper check outbound payment’s memo contains restricted words. | | 400 | outbound_payment_not_allowed | Error returned when the user is not allowed to make this OutboundPayment request. | | 400 | outbound_payment_quote_mismatch | Error returned when key money movement fields on outbound payment quote creation request don’t match outbound payment creation request, including from, to, amount and delivery_options. | | 400 | outbound_payment_quote_missing | Error returned when outbound payment quote is missing for CBPs that requires fee and amount estimates prior to OBP initiation. | | 400 | outbound_payment_recipient_verification_already_consumed | Error returned when the provided recipient verification has been used for another payment. | | 400 | outbound_payment_recipient_verification_awaiting_acknowledgement | Error returned when provided recipient verification has not been acknowledged. | | 400 | outbound_payment_recipient_verification_expired | Error returned when provided recipient verification is expired. | | 400 | outbound_payment_recipient_verification_missing | Error returned when recipient verification is missing for OBPs which requires recipient verification prior to OBP initiation. | | 400 | outbound_payment_recipient_verification_payout_method_mismatch | Error returned when payout method on recipient verification creation request don’t match outbound payment creation request. | | 400 | outbound_payment_recipient_verification_recipient_mismatch | Error returned when recipient on recipient verification creation request don’t match outbound payment creation request. | | 400 | outbound_payment_recipient_verification_recipient_name_outdated | Error returned when the recipient account name of the recipient verification no longer matches the verified name. | | 400 | payout_method_expired | Error returned when the provided payout method is expired. | | 400 | payout_method_unsupported_currency | Error returned when the payout method does not support the request’s payout method currency. | | 400 | payout_method_unusable | Returned if the payout method used for the outbound payment is based on a tokenized account number that is no longer transactable. | | 400 | pending_financial_account | Error returned when the source financial account is in a pending state and not yet active. | | 400 | recipient_amount_limit_exceeded | Error returned when the recipient’s recent total amount in outbound payments has exceeded its limit. | | 400 | recipient_count_limit_exceeded | Error returned when the recipient’s recent outbound payment count has exceeded its limit. | | 400 | recipient_email_does_not_exist | Error returned when the user enables notifications in the OutboundPayment request, but an email is not set up on the recipient account. | | 400 | recipient_feature_not_active | Error returned when recipient does not have the active features required to receive funds from this OutboundPayment request. | | 400 | recipient_feature_not_active_for_suitable_delivery_option | Error returned when user does not specify the delivery option or provides automatic, and recipient feature is not active for suitable delivery option. | | 400 | storer_capability_missing | The required storer capabilities are missing. | | 400 | storer_capability_not_active | The required storer capabilities are not active. | | 400 | unsupported_currency | The currency is not supported for Financial Accounts. | | 400 | unsupported_operation_with_managed_financial_account | Creation of an object is not allowed with a managed account. | | 404 | from_balance_type_not_found | Deprecated. Error returned when balance type of provided financial account in the OutboundPayment/OutboundTransfer request cannot be identified. | | 404 | from_financial_account_not_found | Error returned when financial account in the OutboundPayment/OutboundTransfer request cannot be identified. | | 404 | outbound_payment_recipient_verification_not_found | Error returned when the provided recipient verification cannot be identified. | | 404 | payout_method_invalid | Error returned when the payout method in the OutboundPayment/OutboundTransfer request cannot be identified. | | 404 | to_recipient_not_found | Error returned when the recipient account in the OutboundPayment request cannot be identified. | | 409 | idempotency_conflict | An idempotent retry results in resource conflicts. | | 409 | idempotency_error | An idempotent retry occurred with different request parameters. | ```curl curl -X POST https://api.stripe.com/v2/money_management/outbound_payments \ -H "Authorization: Bearer <>" \ -H "Stripe-Version: 2026-03-25.preview" \ --json '{ "from": { "financial_account": "fa_test_65NybHaQx7KJxDc22rZ16NybHIZ4SQ3LORe4rpuNGDIXEO", "currency": "usd" }, "to": { "recipient": "acct_1Nv0FGQ9RKHgCVdK", "payout_method": "usba_test_61Nyd9YFBVUzLyxXZ16Nyc6oZ4SQv89ZZAqvHiCEC9VQ", "currency": "usd" }, "amount": { "value": 1000, "currency": "usd" }, "description": "Streamer earnings" }' ``` ### Response ```json { "id": "obp_test_65OAfT9tVl3u223h0he16NybHIZ4SQ3LORe4rpuNGDIKCO", "object": "v2.money_management.outbound_payment", "amount": { "value": 1000, "currency": "usd" }, "from": { "debited": { "value": 1000, "currency": "usd" }, "financial_account": "fa_test_65NybHaQx7KJxDc22rZ16NybHIZ4SQ3LORe4rpuNGDIXEO" }, "to": { "credited": { "value": 1000, "currency": "usd" }, "recipient": "acct_1Nv0FGQ9RKHgCVdK", "payout_method": "usba_test_61Nyd9YFBVUzLyxXZ16Nyc6oZ4SQv89ZZAqvHiCEC9VQ" }, "delivery_options": { "bank_account": "automatic" }, "statement_descriptor": "Payment for streaming earnings", "cancelable": true, "description": "Streamer earnings", "status": "processing", "status_transitions": {}, "receipt_url": "https://payments.stripe.com/transaction_receipt/CCMaIwohd2tzcF90ZXN0XzZOeWJISVo0U1EzTE9SZTRycHVOR0RJKOPfpqIGMgZn4xRNQi06oQGUu_fPQJBHgptVXysoOIKNwdFbokEtoKYNk662ox8FRx8ldoJpnlZyFXloJjMW5AQ5dqSks8HidH5PkHyYO91-dYHRZ8kj93mfh2l_efexFDN6EmiZj21RiNDALXuagy2MHFmfrkh6ZiAnjp-MOgqg8IM1RA5Ry5IDL-21Xiair1jWxuVJb3inbrbntL3nk6yjUtXcd_QLofG-Sj2Yz9-NEA", "created": "2023-04-26T23:12:35.952Z", "expected_arrival_date": "2023-04-28T00:00:00Z", "recipient_notification": { "setting": "configured" }, "livemode": false } ```