Package com.stripe.param.treasury

Class OutboundPaymentCreateParams.Builder

java.lang.Object

com.stripe.param.treasury.OutboundPaymentCreateParams.Builder

Enclosing class:

OutboundPaymentCreateParams

public static class OutboundPaymentCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OutboundPaymentCreateParams.Builder	addAllExpand(List<String> elements)	Add all elements to `expand` list.
OutboundPaymentCreateParams.Builder	addExpand(String element)	Add an element to `expand` list.
OutboundPaymentCreateParams	build()	Finalize and obtain parameter instance from this builder.
OutboundPaymentCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
OutboundPaymentCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
OutboundPaymentCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
OutboundPaymentCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
OutboundPaymentCreateParams.Builder	setAmount(Long amount)	Required. Amount (in cents) to be transferred.
OutboundPaymentCreateParams.Builder	setCurrency(String currency)	Required. Three-letter ISO currency code, in lowercase.
OutboundPaymentCreateParams.Builder	setCustomer(String customer)	ID of the customer to whom the OutboundPayment is sent.
OutboundPaymentCreateParams.Builder	setDescription(String description)	An arbitrary string attached to the object.
OutboundPaymentCreateParams.Builder	setDestinationPaymentMethod(String destinationPaymentMethod)	The PaymentMethod to use as the payment instrument for the OutboundPayment.
OutboundPaymentCreateParams.Builder	setDestinationPaymentMethodData(OutboundPaymentCreateParams.DestinationPaymentMethodData destinationPaymentMethodData)	Hash used to generate the PaymentMethod to be used for this OutboundPayment.
OutboundPaymentCreateParams.Builder	setDestinationPaymentMethodOptions(OutboundPaymentCreateParams.DestinationPaymentMethodOptions destinationPaymentMethodOptions)	Payment method-specific configuration for this OutboundPayment.
OutboundPaymentCreateParams.Builder	setEndUserDetails(OutboundPaymentCreateParams.EndUserDetails endUserDetails)	End user details.
OutboundPaymentCreateParams.Builder	setFinancialAccount(String financialAccount)	Required. The FinancialAccount to pull funds from.
OutboundPaymentCreateParams.Builder	setStatementDescriptor(String statementDescriptor)	The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer).

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

Finalize and obtain parameter instance from this builder.

setAmount

public OutboundPaymentCreateParams.Builder setAmount(Long amount)

Required. Amount (in cents) to be transferred.

setCurrency

public OutboundPaymentCreateParams.Builder setCurrency(String currency)

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

setCustomer

public OutboundPaymentCreateParams.Builder setCustomer(String customer)

ID of the customer to whom the OutboundPayment is sent. Must match the Customer attached to the destination_payment_method passed in.

setDescription

public OutboundPaymentCreateParams.Builder setDescription(String description)

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

setDestinationPaymentMethod

public OutboundPaymentCreateParams.Builder setDestinationPaymentMethod(String destinationPaymentMethod)

The PaymentMethod to use as the payment instrument for the OutboundPayment. Exclusive with destination_payment_method_data.

setDestinationPaymentMethodData

public OutboundPaymentCreateParams.Builder setDestinationPaymentMethodData(OutboundPaymentCreateParams.DestinationPaymentMethodData destinationPaymentMethodData)

Hash used to generate the PaymentMethod to be used for this OutboundPayment. Exclusive with destination_payment_method.

setDestinationPaymentMethodOptions

public OutboundPaymentCreateParams.Builder setDestinationPaymentMethodOptions(OutboundPaymentCreateParams.DestinationPaymentMethodOptions destinationPaymentMethodOptions)

Payment method-specific configuration for this OutboundPayment.

setEndUserDetails

public OutboundPaymentCreateParams.Builder setEndUserDetails(OutboundPaymentCreateParams.EndUserDetails endUserDetails)

End user details.

addExpand

public OutboundPaymentCreateParams.Builder addExpand(String element)

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 OutboundPaymentCreateParams.expand for the field documentation.

addAllExpand

public OutboundPaymentCreateParams.Builder addAllExpand(List<String> elements)

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 OutboundPaymentCreateParams.expand for the field documentation.

putExtraParam

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

putAllExtraParam

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

setFinancialAccount

public OutboundPaymentCreateParams.Builder setFinancialAccount(String financialAccount)

Required. The FinancialAccount to pull funds from.

putMetadata

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

putAllMetadata

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

setStatementDescriptor

public OutboundPaymentCreateParams.Builder setStatementDescriptor(String statementDescriptor)

The description that appears on the receiving end for this OutboundPayment (for example, bank statement for external bank transfer). Maximum 10 characters for ach payments, 140 characters for us_domestic_wire payments, or 500 characters for stripe network transfers. The default value is "payment".