Class RecipientCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.RecipientCreateParams

public class RecipientCreateParams extends ApiRequestParams
  • Method Details

    • builder

      public static RecipientCreateParams.Builder builder()
    • getBankAccount

      public String getBankAccount()
      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.
    • getCard

      public String getCard()
      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.
    • getDescription

      public String getDescription()
      An arbitrary string which you can attach to a Recipient object. It is displayed alongside the recipient in the web interface.
    • getEmail

      public String getEmail()
      The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.
    • 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 Object 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.
    • getName

      public String getName()
      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.
    • getTaxId

      public String getTaxId()
      The recipient's tax ID, as a string. For type individual, the full SSN; for type corporation, the full EIN.
    • getType

      public String getType()
      Type of the recipient: either individual or corporation.