Package com.stripe.param

Class PaymentIntentCreateParams.TransferData

java.lang.Object

com.stripe.param.PaymentIntentCreateParams.TransferData

Enclosing class:

PaymentIntentCreateParams

public static class PaymentIntentCreateParams.TransferData
extends Object

State, county, province, or region.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentIntentCreateParams.TransferData.Builder

Method Summary

Modifier and Type	Method	Description
static PaymentIntentCreateParams.TransferData.Builder	builder()
Long	getAmount()	The amount that will be transferred automatically when a charge succeeds.
String	getDestination()	Required. If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account.
Map<String,Object>	getExtraParams()	Map of extra parameters for custom features not available in this client library.

Methods inherited from class java.lang.Object

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

Method Details

builder

public static PaymentIntentCreateParams.TransferData.Builder builder()

getAmount

public Long getAmount()

The amount that will be transferred automatically when a charge succeeds. The amount is capped at the total transaction amount and if no amount is set, the full amount is transferred.

If you intend to collect a fee and you need a more robust reporting experience, using application_fee_amount might be a better fit for your integration.

getDestination

public String getDestination()

Required. If specified, successful charges will be attributed to the destination account for tax reporting, and the funds from charges will be transferred to the destination account. The ID of the resulting transfer will be returned on the successful charge's transfer field.

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.