Package com.stripe.param
Class ChargeUpdateParams
- java.lang.Object
-
- com.stripe.net.ApiRequestParams
-
- com.stripe.param.ChargeUpdateParams
-
public class ChargeUpdateParams extends ApiRequestParams
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ChargeUpdateParams.Builder
static class
ChargeUpdateParams.FraudDetails
static class
ChargeUpdateParams.Shipping
-
Nested classes/interfaces inherited from class com.stripe.net.ApiRequestParams
ApiRequestParams.EnumParam
-
-
Field Summary
-
Fields inherited from class com.stripe.net.ApiRequestParams
EXTRA_PARAMS_KEY
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ChargeUpdateParams.Builder
builder()
java.lang.Object
getCustomer()
The ID of an existing customer that will be associated with this request.java.lang.Object
getDescription()
An arbitrary string which you can attach to a charge object.java.util.List<java.lang.String>
getExpand()
Specifies which fields in the response should be expanded.java.util.Map<java.lang.String,java.lang.Object>
getExtraParams()
Map of extra parameters for custom features not available in this client library.ChargeUpdateParams.FraudDetails
getFraudDetails()
A set of key-value pairs you can attach to a charge giving information about its riskiness.java.lang.Object
getMetadata()
Set of key-value pairs that you can attach to an object.java.lang.Object
getReceiptEmail()
This is the email address that the receipt for this charge will be sent to.ChargeUpdateParams.Shipping
getShipping()
Shipping information for the charge.java.lang.Object
getTransferGroup()
A string that identifies this transaction as part of a group.-
Methods inherited from class com.stripe.net.ApiRequestParams
toMap
-
-
-
-
Method Detail
-
builder
public static ChargeUpdateParams.Builder builder()
-
getCustomer
public java.lang.Object getCustomer()
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.
-
getDescription
public java.lang.Object getDescription()
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 thedescription
of the charge(s) that they are describing.
-
getExpand
public java.util.List<java.lang.String> getExpand()
Specifies which fields in the response should be expanded.
-
getExtraParams
public java.util.Map<java.lang.String,java.lang.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.
-
getFraudDetails
public ChargeUpdateParams.FraudDetails getFraudDetails()
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 auser_report
key with a value offraudulent
. If you believe a charge is safe, include auser_report
key with a value ofsafe
. Stripe will use the information you send to improve our fraud detection algorithms.
-
getMetadata
public java.lang.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 tometadata
.
-
getReceiptEmail
public java.lang.Object getReceiptEmail()
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.
-
getShipping
public ChargeUpdateParams.Shipping getShipping()
Shipping information for the charge. Helps prevent fraud on charges for physical goods.
-
getTransferGroup
public java.lang.Object getTransferGroup()
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.
-
-