Package com.stripe.param

Class PayoutCreateParams.Builder

java.lang.Object
com.stripe.param.PayoutCreateParams.Builder
Enclosing class:
PayoutCreateParams
public static class PayoutCreateParams.Builder extends Object

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

      public PayoutCreateParams build()
      Finalize and obtain parameter instance from this builder.

    • setAmount

      public PayoutCreateParams.Builder setAmount(Long amount)
      Required. A positive integer in cents representing how much to payout.

    • setCurrency

      public PayoutCreateParams.Builder setCurrency(String currency)
      Required. Three-letter ISO currency code, in lowercase. Must be a supported currency.

    • setDescription

      public PayoutCreateParams.Builder setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setDestination

      public PayoutCreateParams.Builder setDestination(String destination)
      The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.

    • addExpand

      public PayoutCreateParams.Builder addExpand(String element)
      Add an element to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PayoutCreateParams.expand for the field documentation.

    • addAllExpand

      public PayoutCreateParams.Builder addAllExpand(List<String> elements)
      Add all elements to `expand` list. A list is initialized for the first `add/addAll` call, and subsequent calls adds additional elements to the original list. See PayoutCreateParams.expand for the field documentation.

    • putExtraParam

      public PayoutCreateParams.Builder putExtraParam(String key, Object value)
      Add a key/value pair to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PayoutCreateParams.extraParams for the field documentation.

    • putAllExtraParam

      public PayoutCreateParams.Builder putAllExtraParam(Map<String,Object> map)
      Add all map key/value pairs to `extraParams` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PayoutCreateParams.extraParams for the field documentation.

    • putMetadata

      public PayoutCreateParams.Builder putMetadata(String key, String value)
      Add a key/value pair to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PayoutCreateParams.metadata for the field documentation.

    • putAllMetadata

      public PayoutCreateParams.Builder putAllMetadata(Map<String,String> map)
      Add all map key/value pairs to `metadata` map. A map is initialized for the first `put/putAll` call, and subsequent calls add additional key/value pairs to the original map. See PayoutCreateParams.metadata for the field documentation.

    • setMethod

      public PayoutCreateParams.Builder setMethod(PayoutCreateParams.Method method)
      The method used to send this payout, which can be standard or instant. instant is supported for payouts to debit cards and bank accounts in certain countries. (See Bank support for Instant Payouts for more information.)

    • setSourceType

      public PayoutCreateParams.Builder setSourceType(PayoutCreateParams.SourceType sourceType)
      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.

    • setStatementDescriptor

      public PayoutCreateParams.Builder setStatementDescriptor(String statementDescriptor)
      A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a statement_descriptor longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.