Class PayoutCreateParams


public class PayoutCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static PayoutCreateParams.Builder builder()
    • getAmount

      public Long getAmount()
      Required. A positive integer in cents representing how much to payout.
    • getCurrency

      public String getCurrency()
      Required. Three-letter ISO currency code, in lowercase. Must be a supported currency.
    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.
    • getDestination

      public String getDestination()
      The ID of a bank account or a card to send the payout to. If you don't provide a destination, we use the default external account for the specified currency.
    • getExpand

      public List<String> getExpand()
      Specifies which fields in the response should be expanded.
    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.
    • getMetadata

      public Map<String,String> getMetadata()
      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.
    • getMethod

      public PayoutCreateParams.Method getMethod()
      The method used to send this payout, which is standard or instant. We support instant for payouts to debit cards and bank accounts in certain countries. Learn more about bank support for Instant Payouts.
    • getSourceType

      public PayoutCreateParams.SourceType getSourceType()
      The balance type of your Stripe balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the Balances API. One of bank_account, card, or fpx.
    • getStatementDescriptor

      public String getStatementDescriptor()
      A string that displays on the recipient's bank or card statement (up to 22 characters). A statement_descriptor that's longer than 22 characters return an error. Most banks truncate this information and display it inconsistently. Some banks might not display it at all.