Package com.stripe.param

Class ChargeUpdateParams.Builder

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

  • Constructor Details

    • Builder

      public Builder()

  • Method Details

    • build

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

    • setCustomer

      public ChargeUpdateParams.Builder setCustomer(String customer)
      The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.

    • setCustomer

      public ChargeUpdateParams.Builder setCustomer(EmptyParam customer)
      The ID of an existing customer that will be associated with this request. This field may only be updated if there is no existing associated customer with this charge.

    • setDescription

      public ChargeUpdateParams.Builder setDescription(String description)
      An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

    • setDescription

      public ChargeUpdateParams.Builder setDescription(EmptyParam description)
      An arbitrary string which you can attach to a charge object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the description of the charge(s) that they are describing.

    • addExpand

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

    • addAllExpand

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

    • putExtraParam

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

    • putAllExtraParam

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

    • setFraudDetails

      public ChargeUpdateParams.Builder setFraudDetails(ChargeUpdateParams.FraudDetails fraudDetails)
      A set of key-value pairs you can attach to a charge giving information about its riskiness. If you believe a charge is fraudulent, include a user_report key with a value of fraudulent. If you believe a charge is safe, include a user_report key with a value of safe. Stripe will use the information you send to improve our fraud detection algorithms.

    • putMetadata

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

    • putAllMetadata

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

    • setMetadata

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

    • setReceiptEmail

      public ChargeUpdateParams.Builder setReceiptEmail(String receiptEmail)
      This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.

    • setReceiptEmail

      public ChargeUpdateParams.Builder setReceiptEmail(EmptyParam receiptEmail)
      This is the email address that the receipt for this charge will be sent to. If this field is updated, then a new email receipt will be sent to the updated address.

    • setShipping

      public ChargeUpdateParams.Builder setShipping(ChargeUpdateParams.Shipping shipping)
      Shipping information for the charge. Helps prevent fraud on charges for physical goods.

    • setTransferGroup

      public ChargeUpdateParams.Builder setTransferGroup(String transferGroup)
      A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.

    • setTransferGroup

      public ChargeUpdateParams.Builder setTransferGroup(EmptyParam transferGroup)
      A string that identifies this transaction as part of a group. transfer_group may only be provided if it has not been set. See the Connect documentation for details.