Package com.stripe.param

Class RecipientUpdateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setBankAccount

      public RecipientUpdateParams.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.

    • setBankAccount

      public RecipientUpdateParams.Builder setBankAccount(EmptyParam 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 RecipientUpdateParams.Builder setCard(String card)
      A U.S. Visa or MasterCard debit card (not prepaid) 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 debit card details, with the options described below. Passing card will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the card creation API. Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.

    • setCard

      public RecipientUpdateParams.Builder setCard(EmptyParam card)
      A U.S. Visa or MasterCard debit card (not prepaid) 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 debit card details, with the options described below. Passing card will create a new card, make it the new recipient default card, and delete the old recipient default (if one exists). If you want to add additional debit cards instead of replacing the existing default, use the card creation API. Whenever you attach a card to a recipient, Stripe will automatically validate the debit card.

    • setDefaultCard

      public RecipientUpdateParams.Builder setDefaultCard(String defaultCard)
      ID of the card to set as the recipient's new default for payouts.

    • setDefaultCard

      public RecipientUpdateParams.Builder setDefaultCard(EmptyParam defaultCard)
      ID of the card to set as the recipient's new default for payouts.

    • setDescription

      public RecipientUpdateParams.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.

    • setDescription

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

    • setEmail

      public RecipientUpdateParams.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.

    • setEmail

      public RecipientUpdateParams.Builder setEmail(EmptyParam 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 RecipientUpdateParams.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 RecipientUpdateParams.expand for the field documentation.

    • addAllExpand

      public RecipientUpdateParams.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 RecipientUpdateParams.expand for the field documentation.

    • putExtraParam

      public RecipientUpdateParams.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 RecipientUpdateParams.extraParams for the field documentation.

    • putAllExtraParam

      public RecipientUpdateParams.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 RecipientUpdateParams.extraParams for the field documentation.

    • putMetadata

      public RecipientUpdateParams.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 RecipientUpdateParams.metadata for the field documentation.

    • putAllMetadata

      public RecipientUpdateParams.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 RecipientUpdateParams.metadata for the field documentation.

    • setMetadata

      public RecipientUpdateParams.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 RecipientUpdateParams.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 RecipientUpdateParams.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.

    • setName

      public RecipientUpdateParams.Builder setName(EmptyParam 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 RecipientUpdateParams.Builder setTaxId(String taxId)
      The recipient's tax ID, as a string. For type individual, the full SSN; for type corporation, the full EIN.

    • setTaxId

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