Package com.stripe.param.v2.payments

Class OffSessionPaymentCreateParams.Builder

java.lang.Object

com.stripe.param.v2.payments.OffSessionPaymentCreateParams.Builder

Enclosing class:

OffSessionPaymentCreateParams

public static class OffSessionPaymentCreateParams.Builder
extends Object

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
OffSessionPaymentCreateParams	build()	Finalize and obtain parameter instance from this builder.
OffSessionPaymentCreateParams.Builder	putAllExtraParam(Map<String,Object> map)	Add all map key/value pairs to `extraParams` map.
OffSessionPaymentCreateParams.Builder	putAllMetadata(Map<String,String> map)	Add all map key/value pairs to `metadata` map.
OffSessionPaymentCreateParams.Builder	putExtraParam(String key, Object value)	Add a key/value pair to `extraParams` map.
OffSessionPaymentCreateParams.Builder	putMetadata(String key, String value)	Add a key/value pair to `metadata` map.
OffSessionPaymentCreateParams.Builder	setAmount(Amount amount)	Required. The “presentment amount” to be collected from the customer.
OffSessionPaymentCreateParams.Builder	setAmountDetails(OffSessionPaymentCreateParams.AmountDetails amountDetails)	Provides industry-specific information about the amount.
OffSessionPaymentCreateParams.Builder	setCadence(OffSessionPaymentCreateParams.Cadence cadence)	Required. The frequency of the underlying payment.
OffSessionPaymentCreateParams.Builder	setCapture(OffSessionPaymentCreateParams.Capture capture)	Details about the capture configuration for the OffSessionPayment.
OffSessionPaymentCreateParams.Builder	setCaptureMethod(OffSessionPaymentCreateParams.CaptureMethod captureMethod)	Whether the OffSessionPayment should be captured automatically or manually.
OffSessionPaymentCreateParams.Builder	setCustomer(String customer)	Required. ID of the Customer to which this OffSessionPayment belongs.
OffSessionPaymentCreateParams.Builder	setOnBehalfOf(String onBehalfOf)	The account (if any) for which the funds of the OffSessionPayment are intended.
OffSessionPaymentCreateParams.Builder	setPaymentMethod(String paymentMethod)	Required. ID of the payment method used in this OffSessionPayment.
OffSessionPaymentCreateParams.Builder	setPaymentMethodOptions(OffSessionPaymentCreateParams.PaymentMethodOptions paymentMethodOptions)	Payment method options for the off-session payment.
OffSessionPaymentCreateParams.Builder	setPaymentsOrchestration(OffSessionPaymentCreateParams.PaymentsOrchestration paymentsOrchestration)	Details about the payments orchestration configuration.
OffSessionPaymentCreateParams.Builder	setRetryDetails(OffSessionPaymentCreateParams.RetryDetails retryDetails)	Details about the OffSessionPayment retries.
OffSessionPaymentCreateParams.Builder	setStatementDescriptor(String statementDescriptor)	Text that appears on the customer’s statement as the statement descriptor for a non-card charge.
OffSessionPaymentCreateParams.Builder	setStatementDescriptorSuffix(String statementDescriptorSuffix)	Provides information about a card charge.
OffSessionPaymentCreateParams.Builder	setTestClock(String testClock)	Test clock that can be used to advance the retry attempts in a sandbox.
OffSessionPaymentCreateParams.Builder	setTransferData(OffSessionPaymentCreateParams.TransferData transferData)	The data that automatically creates a Transfer after the payment finalizes.

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

Finalize and obtain parameter instance from this builder.

setAmount

public OffSessionPaymentCreateParams.Builder setAmount(Amount amount)

Required. The “presentment amount” to be collected from the customer.

setAmountDetails

public OffSessionPaymentCreateParams.Builder setAmountDetails(OffSessionPaymentCreateParams.AmountDetails amountDetails)

Provides industry-specific information about the amount.

setCadence

public OffSessionPaymentCreateParams.Builder setCadence(OffSessionPaymentCreateParams.Cadence cadence)

Required. The frequency of the underlying payment.

setCapture

public OffSessionPaymentCreateParams.Builder setCapture(OffSessionPaymentCreateParams.Capture capture)

Details about the capture configuration for the OffSessionPayment.

setCaptureMethod

public OffSessionPaymentCreateParams.Builder setCaptureMethod(OffSessionPaymentCreateParams.CaptureMethod captureMethod)

Whether the OffSessionPayment should be captured automatically or manually.

setCustomer

public OffSessionPaymentCreateParams.Builder setCustomer(String customer)

Required. ID of the Customer to which this OffSessionPayment belongs.

putExtraParam

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

putAllExtraParam

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

putMetadata

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

putAllMetadata

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

setOnBehalfOf

public OffSessionPaymentCreateParams.Builder setOnBehalfOf(String onBehalfOf)

The account (if any) for which the funds of the OffSessionPayment are intended.

setPaymentMethod

public OffSessionPaymentCreateParams.Builder setPaymentMethod(String paymentMethod)

Required. ID of the payment method used in this OffSessionPayment.

setPaymentMethodOptions

public OffSessionPaymentCreateParams.Builder setPaymentMethodOptions(OffSessionPaymentCreateParams.PaymentMethodOptions paymentMethodOptions)

Payment method options for the off-session payment.

setPaymentsOrchestration

public OffSessionPaymentCreateParams.Builder setPaymentsOrchestration(OffSessionPaymentCreateParams.PaymentsOrchestration paymentsOrchestration)

Details about the payments orchestration configuration.

setRetryDetails

public OffSessionPaymentCreateParams.Builder setRetryDetails(OffSessionPaymentCreateParams.RetryDetails retryDetails)

Details about the OffSessionPayment retries.

setStatementDescriptor

public OffSessionPaymentCreateParams.Builder setStatementDescriptor(String statementDescriptor)

Text that appears on the customer’s statement as the statement descriptor for a non-card charge. This value overrides the account’s default statement descriptor. For information about requirements, including the 22-character limit, see the Statement Descriptor docs.

setStatementDescriptorSuffix

public OffSessionPaymentCreateParams.Builder setStatementDescriptorSuffix(String statementDescriptorSuffix)

Provides information about a card charge. Concatenated to the account’s statement descriptor prefix to form the complete statement descriptor that appears on the customer’s statement.

setTestClock

public OffSessionPaymentCreateParams.Builder setTestClock(String testClock)

Test clock that can be used to advance the retry attempts in a sandbox.

setTransferData

public OffSessionPaymentCreateParams.Builder setTransferData(OffSessionPaymentCreateParams.TransferData transferData)

The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts.