Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create an OutboundPayment 

Treasury
Outbound Payments
Create an OutboundPayment

Creates an OutboundPayment.

Parameters

  • amountintegerRequired

    Amount (in cents) to be transferred.

  • currencyenumRequired

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

  • financial_accountstringRequired

    The FinancialAccount to pull funds from.

  • customerstring

    ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.

  • descriptionstring

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

  • destination_payment_methodstring

    The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with destination_payment_method_data.

  • destination_payment_method_dataobject

    Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.

    • destination_payment_method_data.typeenumRequired

      The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

      Possible enum values
      financial_account
      us_bank_account

    • destination_payment_method_data.billing_detailsobject

      Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.

      • destination_payment_method_data.billing_details.addressobject

        Billing address.

        • destination_payment_method_data.billing_details.address.citystring

          City, district, suburb, town, or village.

        • destination_payment_method_data.billing_details.address.countrystring

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

        • destination_payment_method_data.billing_details.address.line1string

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

        • destination_payment_method_data.billing_details.address.line2string

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

        • destination_payment_method_data.billing_details.address.postal_codestring

          ZIP or postal code.

        • destination_payment_method_data.billing_details.address.statestring

          State, county, province, or region.

      • destination_payment_method_data.billing_details.emailstring

        Email address.

      • destination_payment_method_data.billing_details.namestring

        Full name.

      • destination_payment_method_data.billing_details.phonestring

        Billing phone number (including extension).

    • destination_payment_method_data.financial_accountstring

      Required if type is set to financial_account. The FinancialAccount ID to send funds to.

    • destination_payment_method_data.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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

    • destination_payment_method_data.us_bank_accountobject

      Required hash if type is set to us_bank_account.

      • destination_payment_method_data.us_bank_account.account_holder_typeenum

        Account holder type: individual or company.

        Possible enum values
        company

        Account belongs to a company

        individual

        Account belongs to an individual

      • destination_payment_method_data.us_bank_account.account_numberstring

        Account number of the bank account.

      • destination_payment_method_data.us_bank_account.account_typeenum

        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_data.us_bank_account.financial_connections_accountstring

        The ID of a Financial Connections Account to use as a payment method.

      • destination_payment_method_data.us_bank_account.routing_numberstring

        Routing number of the bank account.

  • destination_payment_method_optionsobject

    Payment method-specific configuration for this OutboundPayment.

    • destination_payment_method_options.us_bank_accountobject

      Optional fields for us_bank_account.

      • destination_payment_method_options.us_bank_account.networkenum

        Specifies the network rails to be used. If not set, will default to the PaymentMethod’s preferred network. 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

  • end_user_detailsobject

    End user details.

    • end_user_details.presentbooleanRequired

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

    • end_user_details.ip_addressstring

      IP address of the user initiating the OutboundPayment. Must be supplied if present is set to true.

  • 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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to metadata.

  • statement_descriptorstring

    The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. The default value is “payment”.

Returns

Returns an OutboundPayment object if there were no issues with OutboundPayment creation.

POST /v1/treasury/outbound_payments
curl https://api.stripe.com/v1/treasury/outbound_payments \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d financial_account=fa_1MtaD72eZvKYlo2CYKM3DnUI \
  -d amount=10000 \
  -d currency=usd \
  -d customer=cus_4QFOF3xrvBT2nU \
  -d destination_payment_method=pm_1MtaD82eZvKYlo2Cn1XtS23o \
  -d description="OutboundPayment to a 3rd party"
Response
{
  "id": "obp_1MtaD72eZvKYlo2Cu5d5S1kX",
  "object": "treasury.outbound_payment",
  "amount": 10000,
  "cancelable": false,
  "created": 1680716009,
  "currency": "usd",
  "customer": "cus_4QFOF3xrvBT2nU",
  "description": "OutboundPayment to a 3rd party",
  "destination_payment_method": "pm_1MtaD82eZvKYlo2CtGr4OxTt",
  "destination_payment_method_details": {
    "type": "us_bank_account",
    "destination": "ba_1MtaD62eZvKYlo2C8vwjm7bc"
  },
  "end_user_details": {
    "ip_address": null,
    "present": false
  },
  "expected_arrival_date": 1680716009,
  "financial_account": "fa_1MtaD72eZvKYlo2CYKM3DnUI",
  "hosted_regulatory_receipt_url": "https://payments.stripe.com/regulatory-receipt/CBQaFwoVYWNjdF8xMDMyRDgyZVp2S1lsbzJDKOrhtqEGMgYgdA-GrKk6NZNsf-FXPEqqbHm44fwJ57pNybbkweviYUDJGYFOw4f9cAqpfvPKQZ6y0S2C5DYyRwmDs_36",
  "livemode": false,
  "metadata": {},
  "returned_details": null,
  "statement_descriptor": "payment",
  "status": "processing",
  "status_transitions": {
    "canceled_at": null,
    "failed_at": null,
    "posted_at": null,
    "returned_at": null
  },
  "transaction": "trxn_1MtaD72eZvKYlo2CmUu4Vs5c"
}