The PayoutMethod object 

Attributes

• idstring

  ID of the PayoutMethod object.

• 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.

• available_payout_speedsarray of enums

  A set of available payout speeds for this payout method.

  Possible enum values

  instant Instant.

  standard Standard.

• bank_accountnullable object

  The PayoutMethodBankAccount object details.

  Hide child attributes

  • 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.

  • bank_account.bank_account_typeenum

    The type of bank account (checking or savings).

    Possible enum values

    checking Checking account.

    savings Savings account.

  • bank_account.bank_namestring

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

  • bank_account.countrystring

    The country code of the bank account.

  • bank_account.enabled_delivery_optionsarray of strings

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

  • bank_account.last4string

    The last 4 digits of the account number.

  • bank_account.routing_numbernullable string

    The routing number of the bank account, if present.

  • bank_account.supported_currenciesarray of strings

    The list of currencies supported by this bank account.

• cardnullable object

  The PayoutMethodCard object details.

  Hide child attributes

  • 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.

  • card.exp_monthstring

    The month the card expires.

  • card.exp_yearstring

    The year the card expires.

  • card.last4string

    The last 4 digits of the card number.

• createdtimestamp

  Created timestamp.

• latest_outbound_setup_intentnullable string

  ID of the underlying active OutboundSetupIntent object, if any.

• livemodeboolean

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

• typeenum

  The type of payout method.

  Possible enum values

  bank_account Bank account.

  card Card.

• usage_statusobject

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

  Hide child attributes

  • 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.

  • 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.