com.stripe.param.PaymentIntentUpdateParams Maven / Gradle / Ivy
// Generated by com.stripe.generator.entity.SdkBuilder
package com.stripe.param;
import com.google.gson.annotations.SerializedName;
import com.stripe.net.ApiRequestParams;
import com.stripe.param.common.EmptyParam;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class PaymentIntentUpdateParams extends ApiRequestParams {
/** Amount intended to be collected by this PaymentIntent. */
@SerializedName("amount")
Long amount;
/**
* The amount of the application fee (if any) for the resulting payment. See the PaymentIntents
* [Connect usage guide](https://stripe.com/docs/payments/payment-intents/usage#connect) for
* details.
*/
@SerializedName("application_fee_amount")
Object applicationFeeAmount;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in
* lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
@SerializedName("currency")
String currency;
/** ID of the customer this PaymentIntent is for if one exists. */
@SerializedName("customer")
String customer;
/** An arbitrary string attached to the object. Often useful for displaying to users. */
@SerializedName("description")
String description;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* 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.
*/
@SerializedName("metadata")
Map metadata;
/** ID of the payment method to attach to this PaymentIntent. */
@SerializedName("payment_method")
String paymentMethod;
/** The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. */
@SerializedName("payment_method_types")
List paymentMethodTypes;
/** Email address that the receipt for the resulting payment will be sent to. */
@SerializedName("receipt_email")
String receiptEmail;
/**
* Set to `true` to save the PaymentIntent's payment method (either `source` or `payment_method`)
* to the associated customer. If the payment method is already attached, this parameter does
* nothing. This parameter defaults to `false` and applies to the payment method passed in the
* same request or the current payment method attached to the PaymentIntent and must be specified
* again if a new payment method is added.
*/
@SerializedName("save_payment_method")
Boolean savePaymentMethod;
/** Shipping information for this PaymentIntent. */
@SerializedName("shipping")
Object shipping;
/** ID of the Source object to attach to this PaymentIntent. */
@SerializedName("source")
String source;
/**
* Extra information about a PaymentIntent. This will appear on your customer's statement when
* this PaymentIntent succeeds in creating a charge.
*/
@SerializedName("statement_descriptor")
String statementDescriptor;
/**
* A string that identifies the resulting payment as part of a group. `transfer_group` may only be
* provided if it has not been set. See the PaymentIntents [Connect usage
* guide](https://stripe.com/docs/payments/payment-intents/usage#connect) for details.
*/
@SerializedName("transfer_group")
String transferGroup;
private PaymentIntentUpdateParams(
Long amount,
Object applicationFeeAmount,
String currency,
String customer,
String description,
List expand,
Map metadata,
String paymentMethod,
List paymentMethodTypes,
String receiptEmail,
Boolean savePaymentMethod,
Object shipping,
String source,
String statementDescriptor,
String transferGroup) {
this.amount = amount;
this.applicationFeeAmount = applicationFeeAmount;
this.currency = currency;
this.customer = customer;
this.description = description;
this.expand = expand;
this.metadata = metadata;
this.paymentMethod = paymentMethod;
this.paymentMethodTypes = paymentMethodTypes;
this.receiptEmail = receiptEmail;
this.savePaymentMethod = savePaymentMethod;
this.shipping = shipping;
this.source = source;
this.statementDescriptor = statementDescriptor;
this.transferGroup = transferGroup;
}
public static Builder builder() {
return new com.stripe.param.PaymentIntentUpdateParams.Builder();
}
public static class Builder {
private Long amount;
private Object applicationFeeAmount;
private String currency;
private String customer;
private String description;
private List expand;
private Map metadata;
private String paymentMethod;
private List paymentMethodTypes;
private String receiptEmail;
private Boolean savePaymentMethod;
private Object shipping;
private String source;
private String statementDescriptor;
private String transferGroup;
/** Finalize and obtain parameter instance from this builder. */
public PaymentIntentUpdateParams build() {
return new PaymentIntentUpdateParams(
this.amount,
this.applicationFeeAmount,
this.currency,
this.customer,
this.description,
this.expand,
this.metadata,
this.paymentMethod,
this.paymentMethodTypes,
this.receiptEmail,
this.savePaymentMethod,
this.shipping,
this.source,
this.statementDescriptor,
this.transferGroup);
}
/** Amount intended to be collected by this PaymentIntent. */
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/**
* The amount of the application fee (if any) for the resulting payment. See the PaymentIntents
* [Connect usage guide](https://stripe.com/docs/payments/payment-intents/usage#connect) for
* details.
*/
public Builder setApplicationFeeAmount(EmptyParam applicationFeeAmount) {
this.applicationFeeAmount = applicationFeeAmount;
return this;
}
/**
* The amount of the application fee (if any) for the resulting payment. See the PaymentIntents
* [Connect usage guide](https://stripe.com/docs/payments/payment-intents/usage#connect) for
* details.
*/
public Builder setApplicationFeeAmount(Long applicationFeeAmount) {
this.applicationFeeAmount = applicationFeeAmount;
return this;
}
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in
* lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/** ID of the customer this PaymentIntent is for if one exists. */
public Builder setCustomer(String customer) {
this.customer = customer;
return this;
}
/** An arbitrary string attached to the object. Often useful for displaying to users. */
public Builder setDescription(String description) {
this.description = description;
return this;
}
/**
* 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 {@link
* PaymentIntentUpdateParams#expand} for the field documentation.
*/
public Builder addExpand(String element) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.add(element);
return this;
}
/**
* 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 {@link
* PaymentIntentUpdateParams#expand} for the field documentation.
*/
public Builder addAllExpand(List elements) {
if (this.expand == null) {
this.expand = new ArrayList<>();
}
this.expand.addAll(elements);
return this;
}
/**
* 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 {@link
* PaymentIntentUpdateParams#metadata} for the field documentation.
*/
public Builder putMetadata(String key, String value) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.put(key, value);
return this;
}
/**
* 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 {@link PaymentIntentUpdateParams#metadata} for the field documentation.
*/
public Builder putAllMetadata(Map map) {
if (this.metadata == null) {
this.metadata = new HashMap<>();
}
this.metadata.putAll(map);
return this;
}
/** ID of the payment method to attach to this PaymentIntent. */
public Builder setPaymentMethod(String paymentMethod) {
this.paymentMethod = paymentMethod;
return this;
}
/**
* Add an element to `paymentMethodTypes` list. A list is initialized for the first `add/addAll`
* call, and subsequent calls adds additional elements to the original list. See {@link
* PaymentIntentUpdateParams#paymentMethodTypes} for the field documentation.
*/
public Builder addPaymentMethodType(String element) {
if (this.paymentMethodTypes == null) {
this.paymentMethodTypes = new ArrayList<>();
}
this.paymentMethodTypes.add(element);
return this;
}
/**
* Add all elements to `paymentMethodTypes` list. A list is initialized for the first
* `add/addAll` call, and subsequent calls adds additional elements to the original list. See
* {@link PaymentIntentUpdateParams#paymentMethodTypes} for the field documentation.
*/
public Builder addAllPaymentMethodType(List elements) {
if (this.paymentMethodTypes == null) {
this.paymentMethodTypes = new ArrayList<>();
}
this.paymentMethodTypes.addAll(elements);
return this;
}
/** Email address that the receipt for the resulting payment will be sent to. */
public Builder setReceiptEmail(String receiptEmail) {
this.receiptEmail = receiptEmail;
return this;
}
/**
* Set to `true` to save the PaymentIntent's payment method (either `source` or
* `payment_method`) to the associated customer. If the payment method is already attached, this
* parameter does nothing. This parameter defaults to `false` and applies to the payment method
* passed in the same request or the current payment method attached to the PaymentIntent and
* must be specified again if a new payment method is added.
*/
public Builder setSavePaymentMethod(Boolean savePaymentMethod) {
this.savePaymentMethod = savePaymentMethod;
return this;
}
/** Shipping information for this PaymentIntent. */
public Builder setShipping(Shipping shipping) {
this.shipping = shipping;
return this;
}
/** Shipping information for this PaymentIntent. */
public Builder setShipping(EmptyParam shipping) {
this.shipping = shipping;
return this;
}
/** ID of the Source object to attach to this PaymentIntent. */
public Builder setSource(String source) {
this.source = source;
return this;
}
/**
* Extra information about a PaymentIntent. This will appear on your customer's statement when
* this PaymentIntent succeeds in creating a charge.
*/
public Builder setStatementDescriptor(String statementDescriptor) {
this.statementDescriptor = statementDescriptor;
return this;
}
/**
* A string that identifies the resulting payment as part of a group. `transfer_group` may only
* be provided if it has not been set. See the PaymentIntents [Connect usage
* guide](https://stripe.com/docs/payments/payment-intents/usage#connect) for details.
*/
public Builder setTransferGroup(String transferGroup) {
this.transferGroup = transferGroup;
return this;
}
}
public static class Shipping {
/** Shipping address. */
@SerializedName("address")
Address address;
/** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */
@SerializedName("carrier")
String carrier;
/** Recipient name. */
@SerializedName("name")
String name;
/** Recipient phone (including extension). */
@SerializedName("phone")
String phone;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple
* tracking numbers were generated for this purchase, please separate them with commas.
*/
@SerializedName("tracking_number")
String trackingNumber;
private Shipping(
Address address, String carrier, String name, String phone, String trackingNumber) {
this.address = address;
this.carrier = carrier;
this.name = name;
this.phone = phone;
this.trackingNumber = trackingNumber;
}
public static Builder builder() {
return new com.stripe.param.PaymentIntentUpdateParams.Shipping.Builder();
}
public static class Builder {
private Address address;
private String carrier;
private String name;
private String phone;
private String trackingNumber;
/** Finalize and obtain parameter instance from this builder. */
public Shipping build() {
return new Shipping(this.address, this.carrier, this.name, this.phone, this.trackingNumber);
}
/** Shipping address. */
public Builder setAddress(Address address) {
this.address = address;
return this;
}
/** The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. */
public Builder setCarrier(String carrier) {
this.carrier = carrier;
return this;
}
/** Recipient name. */
public Builder setName(String name) {
this.name = name;
return this;
}
/** Recipient phone (including extension). */
public Builder setPhone(String phone) {
this.phone = phone;
return this;
}
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple
* tracking numbers were generated for this purchase, please separate them with commas.
*/
public Builder setTrackingNumber(String trackingNumber) {
this.trackingNumber = trackingNumber;
return this;
}
}
public static class Address {
@SerializedName("city")
String city;
@SerializedName("country")
String country;
@SerializedName("line1")
String line1;
@SerializedName("line2")
String line2;
@SerializedName("postal_code")
String postalCode;
@SerializedName("state")
String state;
private Address(
String city,
String country,
String line1,
String line2,
String postalCode,
String state) {
this.city = city;
this.country = country;
this.line1 = line1;
this.line2 = line2;
this.postalCode = postalCode;
this.state = state;
}
public static Builder builder() {
return new com.stripe.param.PaymentIntentUpdateParams.Shipping.Address.Builder();
}
public static class Builder {
private String city;
private String country;
private String line1;
private String line2;
private String postalCode;
private String state;
/** Finalize and obtain parameter instance from this builder. */
public Address build() {
return new Address(
this.city, this.country, this.line1, this.line2, this.postalCode, this.state);
}
public Builder setCity(String city) {
this.city = city;
return this;
}
public Builder setCountry(String country) {
this.country = country;
return this;
}
public Builder setLine1(String line1) {
this.line1 = line1;
return this;
}
public Builder setLine2(String line2) {
this.line2 = line2;
return this;
}
public Builder setPostalCode(String postalCode) {
this.postalCode = postalCode;
return this;
}
public Builder setState(String state) {
this.state = state;
return this;
}
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy