Sign in

Create an OutboundPayment

Creates an OutboundPayment.

post/v1/treasury/outbound_payments

Response

Successful response.

amountinteger required

Amount (in cents) transferred.

cancelableboolean required

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

createdinteger required

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

currencystring currency required

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

customerstring nullable

ID of the customer to whom an OutboundPayment is sent.

descriptionstring nullable

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

destination_payment_methodstring nullable

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

expected_arrival_dateinteger required

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

financial_accountstring required

The FinancialAccount that funds were pulled from.

hosted_regulatory_receipt_urlstring nullable

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

idstring required

Unique identifier for the object.

livemodeboolean required

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

metadataobject required

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.

object'treasury.outbound_payment' required

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

statement_descriptorstring required

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

status'canceled' | 'failed' | 'posted' | 'processing' | 'returned' required

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.

Changes

Changed in 10 of the 51 revisions of this API.161724

  • 62e8dc4ed8691See the full diff
    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/card_present/anyOf[subschema #1: payment_method_options_card_present]/capture_method to the response with the default status

      response-optional-property-added

  • 1e483c60b4801See the full diff
    • ○

      added the optional property error/payment_intent/amount_details/anyOf[subschema #1: PaymentFlowsAmountDetails]/line_items/data/items/payment_method_options/anyOf[subschema #1: PaymentFlowsAmountDetailsResourceLineItemsListResourceLineItemResourcePaymentMethodOptions]/klarna/subscription_reference to the response with the default status

      response-optional-property-added

  • 7b79777e9bbd2See the full diff
    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/location to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paynow/reader to the response with the default status

      response-optional-property-added

  • c4dc6dbe947e1See the full diff
    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/cashapp/transaction_id to the response with the default status

      response-optional-property-added

  • 34998f9d7d731See the full diff
    • ●

      removed the request property destination_payment_method_data/billing_details/tax_id

      request-property-removed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • 1199cc3c557429See the full diff
    • ▲

      the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default

      response-property-became-optional

    • ▲

      the response property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/price_type became optional for the status default

      response-property-became-optional

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/applicability_config/scope/prices to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/total_pretax_credit_amounts/items/credit_balance_transaction/anyOf[subschema #2: CreditBalanceTransaction]/credit_grant/anyOf[subschema #2: CreditGrant]/priority to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/acss_debit/anyOf[subschema #1: payment_intent_payment_method_options_acss_debit]/target_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/au_becs_debit/anyOf[subschema #1: payment_intent_payment_method_options_au_becs_debit]/target_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/bacs_debit/anyOf[subschema #1: payment_intent_payment_method_options_bacs_debit]/target_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/sepa_debit/anyOf[subschema #1: payment_intent_payment_method_options_sepa_debit]/target_date to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/us_bank_account/anyOf[subschema #1: payment_intent_payment_method_options_us_bank_account]/target_date to the response with the default status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • b8a91ebdacb78See the full diff
    • ○

      added the optional property error/advice_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/outcome/anyOf[subschema #1: ChargeOutcome]/advice_code to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/pay_by_bank to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/paypal/country to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/payment_method_options/anyOf[subschema #1: PaymentIntentPaymentMethodOptions]/pay_by_bank to the response with the default status

      response-optional-property-added

  • 46de5407335916See the full diff
    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/customer_tax_ids/items/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/invoice_item/anyOf[subschema #2: InvoiceItem]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/lines/data/items/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/quote/anyOf[subschema #2: Quote]/subscription_schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/default_settings/invoice_settings/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    • ●

      added the new al_tin enum value to the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/subscription/anyOf[subschema #2: Subscription]/schedule/anyOf[subschema #2: SubscriptionSchedule]/phases/items/invoice_settings/anyOf[subschema #1: InvoiceSettingSubscriptionSchedulePhaseSetting]/account_tax_ids/items/anyOf[subschema #2: tax_id]/type response property for the response status default

      response-property-enum-value-added

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

  • d8ab202758612See the full diff
    • ○

      added the optional property error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status

      response-optional-property-added

    • ○

      added the optional property error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/payment_method_details/anyOf[subschema #1: payment_method_details]/card/network_transaction_id to the response with the default status

      response-optional-property-added

  • 33103c93fb8c14See the full diff
    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/invoice/anyOf[subschema #2: Invoice]/charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/application_fee/anyOf[subschema #2: PlatformFee]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #12: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/failure_balance_transaction/anyOf[subschema #2: BalanceTransaction]/source/anyOf[subschema #5: CustomerCashBalanceTransaction]/refunded_from_payment/refund/anyOf[subschema #2: Refund]/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    • ▲

      the error/payment_intent/latest_charge/anyOf[subschema #2: Charge]/refunds/data/items/next_action/display_details response's property type/format changed from / to object/ for status default

      response-property-type-changed

    This revision's changelog hit the recording limit, so it may not list every change to this endpoint.

Of the 51 revisions, 14 have no diff computed and 6 have a changelog that could not be searched.