com.stripe.param

Class ChargeUpdateParams.Builder

java.lang.Object

com.stripe.param.ChargeUpdateParams.Builder

Enclosing class:

ChargeUpdateParams

public static class ChargeUpdateParams.Builder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ChargeUpdateParams.Builder	addAllExpand(java.util.List<java.lang.String> elements) Add all elements to `expand` list.
ChargeUpdateParams.Builder	addExpand(java.lang.String element) Add an element to `expand` list.
ChargeUpdateParams	build() Finalize and obtain parameter instance from this builder.
ChargeUpdateParams.Builder	putAllExtraParam(java.util.Map<java.lang.String,java.lang.Object> map) Add all map key/value pairs to `extraParams` map.
ChargeUpdateParams.Builder	putAllMetadata(java.util.Map<java.lang.String,java.lang.String> map) Add all map key/value pairs to `metadata` map.
ChargeUpdateParams.Builder	putExtraParam(java.lang.String key, java.lang.Object value) Add a key/value pair to `extraParams` map.
ChargeUpdateParams.Builder	putMetadata(java.lang.String key, java.lang.String value) Add a key/value pair to `metadata` map.
ChargeUpdateParams.Builder	setCustomer(java.lang.String customer) The ID of an existing customer that will be associated with this request.
ChargeUpdateParams.Builder	setDescription(java.lang.String description) An arbitrary string which you can attach to a charge object.
ChargeUpdateParams.Builder	setFraudDetails(ChargeUpdateParams.FraudDetails fraudDetails) A set of key-value pairs you can attach to a charge giving information about its riskiness.
ChargeUpdateParams.Builder	setReceiptEmail(java.lang.String receiptEmail) This is the email address that the receipt for this charge will be sent to.
ChargeUpdateParams.Builder	setShipping(ChargeUpdateParams.Shipping shipping) Shipping information for the charge.
ChargeUpdateParams.Builder	setTransferGroup(java.lang.String transferGroup) A string that identifies this transaction as part of a group.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

build

public ChargeUpdateParams build()

Finalize and obtain parameter instance from this builder.

setCustomer

public ChargeUpdateParams.Builder setCustomer(java.lang.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.

setDescription

public ChargeUpdateParams.Builder setDescription(java.lang.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.

addExpand

public ChargeUpdateParams.Builder addExpand(java.lang.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(java.util.List<java.lang.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(java.lang.String key,
                                                java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.lang.String key,
                                              java.lang.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(java.util.Map<java.lang.String,java.lang.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.

setReceiptEmail

public ChargeUpdateParams.Builder setReceiptEmail(java.lang.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.

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(java.lang.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](https://stripe.com/docs/connect/charges-transfers#grouping-transactions) for details.