Class RecipientCreateParams.Builder

java.lang.Object
com.stripe.param.RecipientCreateParams.Builder
Enclosing class:
RecipientCreateParams

public static class RecipientCreateParams.Builder extends Object
  • Constructor Details

    • Builder

      public Builder()
  • Method Details

    • build

      public RecipientCreateParams build()
      Finalize and obtain parameter instance from this builder.
    • setBankAccount

      public RecipientCreateParams.Builder setBankAccount(String bankAccount)
      A bank account to attach to the recipient. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's bank account details, with the options described below.
    • setCard

      public RecipientCreateParams.Builder setCard(String card)
      A U.S. Visa or MasterCard debit card (not prepaid) to attach to the recipient. If the debit card is not valid, recipient creation will fail. You can provide either a token, like the ones returned by Stripe.js, or a dictionary containing a user's debit card details, with the options described below. Although not all information is required, the extra info helps prevent fraud.
    • setDescription

      public RecipientCreateParams.Builder setDescription(String description)
      An arbitrary string which you can attach to a Recipient object. It is displayed alongside the recipient in the web interface.
    • setEmail

      public RecipientCreateParams.Builder setEmail(String email)
      The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.
    • addExpand

      public RecipientCreateParams.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 RecipientCreateParams.expand for the field documentation.
    • addAllExpand

      public RecipientCreateParams.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 RecipientCreateParams.expand for the field documentation.
    • putExtraParam

      public RecipientCreateParams.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 RecipientCreateParams.extraParams for the field documentation.
    • putAllExtraParam

      public RecipientCreateParams.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 RecipientCreateParams.extraParams for the field documentation.
    • putMetadata

      public RecipientCreateParams.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 RecipientCreateParams.metadata for the field documentation.
    • putAllMetadata

      public RecipientCreateParams.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 RecipientCreateParams.metadata for the field documentation.
    • setMetadata

      public RecipientCreateParams.Builder setMetadata(EmptyParam metadata)
      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.
    • setMetadata

      public RecipientCreateParams.Builder setMetadata(Map<String,String> metadata)
      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.
    • setName

      public RecipientCreateParams.Builder setName(String name)
      The recipient's full, legal name. For type individual, should be in the format First Last, First Middle Last, or First M Last (no prefixes or suffixes). For corporation, the full, incorporated name.
    • setTaxId

      public RecipientCreateParams.Builder setTaxId(String taxId)
      The recipient's tax ID, as a string. For type individual, the full SSN; for type corporation, the full EIN.
    • setType

      public RecipientCreateParams.Builder setType(String type)
      Type of the recipient: either individual or corporation.