Package com.stripe.param.v2.moneymanagement

Class PayoutIntentCreateParams.Builder

java.lang.Object

com.stripe.param.v2.moneymanagement.PayoutIntentCreateParams.Builder

Enclosing class:

PayoutIntentCreateParams

public static class PayoutIntentCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PayoutIntentCreateParams	build()	Finalize and obtain parameter instance from this builder.
PayoutIntentCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
PayoutIntentCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
PayoutIntentCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
PayoutIntentCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
PayoutIntentCreateParams.Builder	setAmount(Amount amount)	Required. The monetary amount to be sent.
PayoutIntentCreateParams.Builder	setConfirmationMethod(PayoutIntentCreateParams.ConfirmationMethod confirmationMethod)	Controls whether the PayoutIntent requires explicit confirmation before transitioning to pending.
PayoutIntentCreateParams.Builder	setDescription(String description)	An arbitrary string attached to the PayoutIntent.
PayoutIntentCreateParams.Builder	setFrom(PayoutIntentCreateParams.From from)	Required. The FinancialAccount that funds are pulled from.
PayoutIntentCreateParams.Builder	setRecipientNotification(PayoutIntentCreateParams.RecipientNotification recipientNotification)	Recipient notification settings for the PayoutIntent.
PayoutIntentCreateParams.Builder	setScheduleOptions(PayoutIntentCreateParams.ScheduleOptions scheduleOptions)	Scheduling options for the payout.
PayoutIntentCreateParams.Builder	setStatementDescriptor(String statementDescriptor)	The description that appears on the receiving end for the payout (for example, on a bank statement).
PayoutIntentCreateParams.Builder	setTo(PayoutIntentCreateParams.To to)	Required. To which payout method the payout is sent.

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 PayoutIntentCreateParams build()

Finalize and obtain parameter instance from this builder.

setAmount

public PayoutIntentCreateParams.Builder setAmount(Amount amount)

Required. The monetary amount to be sent.

setConfirmationMethod

public PayoutIntentCreateParams.Builder setConfirmationMethod(PayoutIntentCreateParams.ConfirmationMethod confirmationMethod)

Controls whether the PayoutIntent requires explicit confirmation before transitioning to pending. Defaults to automatic, but regulatory requirements may still require confirmation. See Send money with Global Payouts for details.

setDescription

public PayoutIntentCreateParams.Builder setDescription(String description)

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

putExtraParam

public PayoutIntentCreateParams.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 PayoutIntentCreateParams.extraParams for the field documentation.

putAllExtraParam

public PayoutIntentCreateParams.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 PayoutIntentCreateParams.extraParams for the field documentation.

setFrom

public PayoutIntentCreateParams.Builder setFrom(PayoutIntentCreateParams.From from)

Required. The FinancialAccount that funds are pulled from.

putMetadata

public PayoutIntentCreateParams.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 PayoutIntentCreateParams.metadata for the field documentation.

putAllMetadata

public PayoutIntentCreateParams.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 PayoutIntentCreateParams.metadata for the field documentation.

setRecipientNotification

public PayoutIntentCreateParams.Builder setRecipientNotification(PayoutIntentCreateParams.RecipientNotification recipientNotification)

Recipient notification settings for the PayoutIntent. Only applicable when the PayoutIntent creates an OutboundPayment.

setScheduleOptions

public PayoutIntentCreateParams.Builder setScheduleOptions(PayoutIntentCreateParams.ScheduleOptions scheduleOptions)

Scheduling options for the payout. If omitted, the payout is scheduled for immediate execution.

setStatementDescriptor

public PayoutIntentCreateParams.Builder setStatementDescriptor(String statementDescriptor)

The description that appears on the receiving end for the payout (for example, on a bank statement).

setTo

public PayoutIntentCreateParams.Builder setTo(PayoutIntentCreateParams.To to)

Required. To which payout method the payout is sent.