Package com.stripe.param

Class PaymentIntentCreateParams.TransferData.Builder

java.lang.Object

com.stripe.param.PaymentIntentCreateParams.TransferData.Builder

Enclosing class:

PaymentIntentCreateParams.TransferData

public static class PaymentIntentCreateParams.TransferData.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PaymentIntentCreateParams.TransferData	build()	Finalize and obtain parameter instance from this builder.
PaymentIntentCreateParams.TransferData.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PaymentIntentCreateParams.TransferData.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PaymentIntentCreateParams.TransferData.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PaymentIntentCreateParams.TransferData.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PaymentIntentCreateParams.TransferData.Builder	setAmount(Long amount)	The amount that will be transferred automatically when a charge succeeds.
PaymentIntentCreateParams.TransferData.Builder	setDescription(String description)	An arbitrary string attached to the transfer.
PaymentIntentCreateParams.TransferData.Builder	setDestination(String destination)	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.
PaymentIntentCreateParams.TransferData.Builder	setMetadata(EmptyParam metadata)	Set of key-value pairs that you can attach to an object.
PaymentIntentCreateParams.TransferData.Builder	setMetadata(Map<String,String> metadata)	Set of key-value pairs that you can attach to an object.
PaymentIntentCreateParams.TransferData.Builder	setPaymentData(PaymentIntentCreateParams.TransferData.PaymentData paymentData)	The data with which to populate the destination payment.

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

build

public PaymentIntentCreateParams.TransferData build()

Finalize and obtain parameter instance from this builder.

setAmount

public PaymentIntentCreateParams.TransferData.Builder setAmount(Long amount)

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.

setDescription

public PaymentIntentCreateParams.TransferData.Builder setDescription(String description)

An arbitrary string attached to the transfer. Often useful for displaying to users.

setDestination

public PaymentIntentCreateParams.TransferData.Builder setDestination(String destination)

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.

putExtraParam

public PaymentIntentCreateParams.TransferData.Builder putExtraParam(String key,
 Object value)

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 PaymentIntentCreateParams.TransferData.extraParams for the field documentation.

putAllExtraParam

public PaymentIntentCreateParams.TransferData.Builder putAllExtraParam(Map<String,Object> map)

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 PaymentIntentCreateParams.TransferData.extraParams for the field documentation.

putMetadata

public PaymentIntentCreateParams.TransferData.Builder putMetadata(String key,
 String value)

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 PaymentIntentCreateParams.TransferData.metadata for the field documentation.

putAllMetadata

public PaymentIntentCreateParams.TransferData.Builder putAllMetadata(Map<String,String> map)

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 PaymentIntentCreateParams.TransferData.metadata for the field documentation.

setMetadata

public PaymentIntentCreateParams.TransferData.Builder setMetadata(EmptyParam metadata)

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.

setMetadata

public PaymentIntentCreateParams.TransferData.Builder setMetadata(Map<String,String> metadata)

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.

setPaymentData

public PaymentIntentCreateParams.TransferData.Builder setPaymentData(PaymentIntentCreateParams.TransferData.PaymentData paymentData)

The data with which to populate the destination payment.