The OutboundSetupIntent object 

Attributes

• idstring

  ID of the outbound setup intent.

• objectstring, value is "v2.money_management.outbound_setup_intent"

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

• createdtimestamp

  Created timestamp.

• livemodeboolean

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

• next_actionnullable object

  Specifies which actions needs to be taken next to continue setup of the credential.

  Hide child attributes

  • next_action.confirmation_of_payeenullable object

    Confirmation of Payee details.

    Hide child attributes

    • next_action.confirmation_of_payee.objectstring

      The type of the credential.

    • next_action.confirmation_of_payee.statusenum

      The Confirmation of Payee status.

      Possible enum values

      awaiting_acknowledgement The check resulted in a non-match, partial match, or the service was unavailable. Explicit acknowledgement is required to make payments to this account.

      confirmed Either the account matches what was provided or there was explicit acknowledgement of the status. OutboundPayments can be made to the bank account.

      uninitiated No confirmation of payee check has happened on this account. Use InitiateConfirmationOfPayee to check the user’s information against bank records before making OutboundPayments.

  • next_action.typeenum

    The type of next action.

    Possible enum values

    confirmation_of_payee Confirmation of Payee must be performed in order to make this payout method usable for the specified outbound money movement.

• payout_methodobject

  Information about the payout method that’s created and linked to this outbound setup intent.

  Hide child attributes

  • payout_method.idstring

    ID of the PayoutMethod object.

  • payout_method.objectstring, value is "v2.money_management.payout_method"

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

  • payout_method.available_payout_speedsarray of enums

    A set of available payout speeds for this payout method.

    Possible enum values

    instant Instant.

    standard Standard.

  • payout_method.bank_accountnullable object

    The PayoutMethodBankAccount object details.

    Hide child attributes

    • payout_method.bank_account.archivedboolean

      Whether this PayoutMethodBankAccount object was archived. PayoutMethodBankAccount objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodBankAccount objects cannot be used as payout methods and will not appear in the payout method list.

    • payout_method.bank_account.bank_account_typeenum

      The type of bank account (checking or savings).

      Possible enum values

      checking Checking account.

      savings Savings account.

    • payout_method.bank_account.bank_namestring

      The name of the bank this bank account is in. This field is populated automatically by Stripe.

    • payout_method.bank_account.countrystring

      The country code of the bank account.

    • payout_method.bank_account.enabled_delivery_optionsarray of strings

      List of enabled flows for this bank account (wire or local).

    • payout_method.bank_account.last4string

      The last 4 digits of the account number.

    • payout_method.bank_account.routing_numbernullable string

      The routing number of the bank account, if present.

    • payout_method.bank_account.supported_currenciesarray of strings

      The list of currencies supported by this bank account.

  • payout_method.cardnullable object

    The PayoutMethodCard object details.

    Hide child attributes

    • payout_method.card.archivedboolean

      Whether the PayoutMethodCard object was archived. PayoutMethodCard objects can be archived through the /archive API, and they will not be automatically archived by Stripe. Archived PayoutMethodCard objects cannot be used as payout methods and will not appear in the payout method list.

    • payout_method.card.exp_monthstring

      The month the card expires.

    • payout_method.card.exp_yearstring

      The year the card expires.

    • payout_method.card.last4string

      The last 4 digits of the card number.

  • payout_method.createdtimestamp

    Created timestamp.

  • payout_method.latest_outbound_setup_intentnullable string

    ID of the underlying active OutboundSetupIntent object, if any.

  • payout_method.livemodeboolean

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

  • payout_method.typeenum

    The type of payout method.

    Possible enum values

    bank_account Bank account.

    card Card.

    crypto_wallet Crypto wallet.

  • payout_method.usage_statusobject

    Indicates whether the payout method has met the necessary requirements for outbound money movement.

    Hide child attributes

    • payout_method.usage_status.paymentsenum

      Payments status - used when sending OutboundPayments (sending funds to recipients).

      Possible enum values

      eligible Resources that have met all the necessary requirements.

      invalid Resources that can’t ever support the specified flow (e.g credit cards for transfers).

      requires_action Resources that need to meet more requirements / need to do more actions in order to be made usable.

    • payout_method.usage_status.transfersenum

      Transfers status - used when making an OutboundTransfer (sending funds to yourself).

      Possible enum values

      eligible Resources that have met all the necessary requirements.

      invalid Resources that can’t ever support the specified flow (e.g credit cards for transfers).

      requires_action Resources that need to meet more requirements / need to do more actions in order to be made usable.

• statusenum

  Status of the outbound setup intent.

  Possible enum values

  canceled The user may cancel the outbound setup intent at any time prior to reaching the succeeded status. The outbound setup intent will no longer be usable. This is a terminal status.

  requires_action Some additional setup steps need to be done to fully set up the credential for the specified usage intent. Additional steps are specified in next_action.

  requires_payout_method When the outbound setup intent is created, it begins in this status if no payout_method_data is provided. The outbound setup intent will also transition back to this status if a setup failure occurs. The user will then need to provide new payout_method_data to continue.

  succeeded If no additional setup actions need to be done i.e. credential is fully set up for the specified usage intent. This is a terminal status.

• usage_intentenum

  The intended money movement flow this payout method should be set up for, specified in params.

  Possible enum values

  payment Setup for outbound payments.

  transfer Setup for outbound transfers.