Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// File generated from our OpenAPI spec
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;
import lombok.Getter;
@Getter
public class RefundCreateParams extends ApiRequestParams {
@SerializedName("amount")
Long amount;
/** The identifier of the charge to refund. */
@SerializedName("charge")
String charge;
/**
* Three-letter ISO currency code,
* in lowercase. Must be a supported currency.
*/
@SerializedName("currency")
String currency;
/** Customer whose customer balance to refund from. */
@SerializedName("customer")
String customer;
/** Specifies which fields in the response should be expanded. */
@SerializedName("expand")
List expand;
/**
* 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 {@code @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.
*/
@SerializedName(ApiRequestParams.EXTRA_PARAMS_KEY)
Map extraParams;
/**
* For payment methods without native refund support (e.g., Konbini, PromptPay), use this email
* from the customer to receive refund instructions.
*/
@SerializedName("instructions_email")
String instructionsEmail;
/**
* 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 {@code metadata}.
*/
@SerializedName("metadata")
Object metadata;
/** Origin of the refund. */
@SerializedName("origin")
Origin origin;
/** The identifier of the PaymentIntent to refund. */
@SerializedName("payment_intent")
String paymentIntent;
/**
* String indicating the reason for the refund. If set, possible values are {@code duplicate},
* {@code fraudulent}, and {@code requested_by_customer}. If you believe the charge to be
* fraudulent, specifying {@code fraudulent} as the reason will add the associated card and email
* to your block lists, and will also help us
* improve our fraud detection algorithms.
*/
@SerializedName("reason")
Reason reason;
/**
* Boolean indicating whether the application fee should be refunded when refunding this charge.
* If a full charge refund is given, the full application fee will be refunded. Otherwise, the
* application fee will be refunded in an amount proportional to the amount of the charge
* refunded. An application fee can be refunded only by the application that created the charge.
*/
@SerializedName("refund_application_fee")
Boolean refundApplicationFee;
/**
* Boolean indicating whether the transfer should be reversed when refunding this charge. The
* transfer will be reversed proportionally to the amount being refunded (either the entire or
* partial amount).
*
* A transfer can be reversed only by the application that created the charge.
*/
@SerializedName("reverse_transfer")
Boolean reverseTransfer;
private RefundCreateParams(
Long amount,
String charge,
String currency,
String customer,
List expand,
Map extraParams,
String instructionsEmail,
Object metadata,
Origin origin,
String paymentIntent,
Reason reason,
Boolean refundApplicationFee,
Boolean reverseTransfer) {
this.amount = amount;
this.charge = charge;
this.currency = currency;
this.customer = customer;
this.expand = expand;
this.extraParams = extraParams;
this.instructionsEmail = instructionsEmail;
this.metadata = metadata;
this.origin = origin;
this.paymentIntent = paymentIntent;
this.reason = reason;
this.refundApplicationFee = refundApplicationFee;
this.reverseTransfer = reverseTransfer;
}
public static Builder builder() {
return new Builder();
}
public static class Builder {
private Long amount;
private String charge;
private String currency;
private String customer;
private List expand;
private Map extraParams;
private String instructionsEmail;
private Object metadata;
private Origin origin;
private String paymentIntent;
private Reason reason;
private Boolean refundApplicationFee;
private Boolean reverseTransfer;
/** Finalize and obtain parameter instance from this builder. */
public RefundCreateParams build() {
return new RefundCreateParams(
this.amount,
this.charge,
this.currency,
this.customer,
this.expand,
this.extraParams,
this.instructionsEmail,
this.metadata,
this.origin,
this.paymentIntent,
this.reason,
this.refundApplicationFee,
this.reverseTransfer);
}
public Builder setAmount(Long amount) {
this.amount = amount;
return this;
}
/** The identifier of the charge to refund. */
public Builder setCharge(String charge) {
this.charge = charge;
return this;
}
/**
* Three-letter ISO currency
* code, in lowercase. Must be a supported
* currency.
*/
public Builder setCurrency(String currency) {
this.currency = currency;
return this;
}
/** Customer whose customer balance to refund from. */
public Builder setCustomer(String customer) {
this.customer = customer;
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
* RefundCreateParams#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
* RefundCreateParams#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 `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 {@link
* RefundCreateParams#extraParams} for the field documentation.
*/
public Builder putExtraParam(String key, Object value) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.put(key, value);
return this;
}
/**
* 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 {@link RefundCreateParams#extraParams} for the field documentation.
*/
public Builder putAllExtraParam(Map map) {
if (this.extraParams == null) {
this.extraParams = new HashMap<>();
}
this.extraParams.putAll(map);
return this;
}
/**
* For payment methods without native refund support (e.g., Konbini, PromptPay), use this email
* from the customer to receive refund instructions.
*/
public Builder setInstructionsEmail(String instructionsEmail) {
this.instructionsEmail = instructionsEmail;
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
* RefundCreateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putMetadata(String key, String value) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) 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 RefundCreateParams#metadata} for the field documentation.
*/
@SuppressWarnings("unchecked")
public Builder putAllMetadata(Map map) {
if (this.metadata == null || this.metadata instanceof EmptyParam) {
this.metadata = new HashMap();
}
((Map) this.metadata).putAll(map);
return this;
}
/**
* 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 {@code metadata}.
*/
public Builder setMetadata(EmptyParam metadata) {
this.metadata = metadata;
return this;
}
/**
* 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 {@code metadata}.
*/
public Builder setMetadata(Map metadata) {
this.metadata = metadata;
return this;
}
/** Origin of the refund. */
public Builder setOrigin(RefundCreateParams.Origin origin) {
this.origin = origin;
return this;
}
/** The identifier of the PaymentIntent to refund. */
public Builder setPaymentIntent(String paymentIntent) {
this.paymentIntent = paymentIntent;
return this;
}
/**
* String indicating the reason for the refund. If set, possible values are {@code duplicate},
* {@code fraudulent}, and {@code requested_by_customer}. If you believe the charge to be
* fraudulent, specifying {@code fraudulent} as the reason will add the associated card and
* email to your block lists, and will also
* help us improve our fraud detection algorithms.
*/
public Builder setReason(RefundCreateParams.Reason reason) {
this.reason = reason;
return this;
}
/**
* Boolean indicating whether the application fee should be refunded when refunding this charge.
* If a full charge refund is given, the full application fee will be refunded. Otherwise, the
* application fee will be refunded in an amount proportional to the amount of the charge
* refunded. An application fee can be refunded only by the application that created the charge.
*/
public Builder setRefundApplicationFee(Boolean refundApplicationFee) {
this.refundApplicationFee = refundApplicationFee;
return this;
}
/**
* Boolean indicating whether the transfer should be reversed when refunding this charge. The
* transfer will be reversed proportionally to the amount being refunded (either the entire or
* partial amount).
*
* A transfer can be reversed only by the application that created the charge.
*/
public Builder setReverseTransfer(Boolean reverseTransfer) {
this.reverseTransfer = reverseTransfer;
return this;
}
}
public enum Origin implements ApiRequestParams.EnumParam {
@SerializedName("customer_balance")
CUSTOMER_BALANCE("customer_balance");
@Getter(onMethod_ = {@Override})
private final String value;
Origin(String value) {
this.value = value;
}
}
public enum Reason implements ApiRequestParams.EnumParam {
@SerializedName("duplicate")
DUPLICATE("duplicate"),
@SerializedName("fraudulent")
FRAUDULENT("fraudulent"),
@SerializedName("requested_by_customer")
REQUESTED_BY_CUSTOMER("requested_by_customer");
@Getter(onMethod_ = {@Override})
private final String value;
Reason(String value) {
this.value = value;
}
}
}
