Package com.stripe.param

Class RefundCreateParams

java.lang.Object

com.stripe.net.ApiRequestParams

com.stripe.param.RefundCreateParams

public class RefundCreateParams
extends ApiRequestParams

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RefundCreateParams.Builder
static enum	RefundCreateParams.Origin
static enum	RefundCreateParams.Reason

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

Modifier and Type	Method	Description
static RefundCreateParams.Builder	builder()
Long	getAmount()	A positive integer representing how much to refund.
String	getCharge()
String	getCurrency()	Three-letter ISO currency code, in lowercase.
String	getCustomer()	Customer whose customer balance to refund from.
List<String>	getExpand()	Specifies which fields in the response should be expanded.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.
String	getInstructionsEmail()	For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.
Object	getMetadata()	Set of key-value pairs that you can attach to an object.
RefundCreateParams.Origin	getOrigin()	Origin of the refund.
String	getPaymentIntent()
RefundCreateParams.Reason	getReason()
Boolean	getRefundApplicationFee()
Boolean	getReverseTransfer()

Methods inherited from class com.stripe.net.ApiRequestParams

toMap

Methods inherited from class java.lang.Object

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

Method Details

builder

public static RefundCreateParams.Builder builder()

getAmount

public Long getAmount()

A positive integer representing how much to refund.

getCharge

public String getCharge()

getCurrency

public String getCurrency()

Three-letter ISO currency code, in lowercase. Must be a supported currency.

getCustomer

public String getCustomer()

Customer whose customer balance to refund from.

getExpand

public List<String> getExpand()

Specifies which fields in the response should be expanded.

getExtraParams

public Map<String,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.

getInstructionsEmail

public String getInstructionsEmail()

For payment methods without native refund support (e.g., Konbini, PromptPay), use this email from the customer to receive refund instructions.

getMetadata

public 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 to metadata.

getOrigin

public RefundCreateParams.Origin getOrigin()

Origin of the refund.

getPaymentIntent

public String getPaymentIntent()

getReason

public RefundCreateParams.Reason getReason()

getRefundApplicationFee

public Boolean getRefundApplicationFee()

getReverseTransfer

public Boolean getReverseTransfer()