Package com.stripe.param.v2.payments
Class OffSessionPaymentCreateParams.Builder
java.lang.Object
com.stripe.param.v2.payments.OffSessionPaymentCreateParams.Builder
- Enclosing class:
- OffSessionPaymentCreateParams
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionbuild()
Finalize and obtain parameter instance from this builder.putAllExtraParam
(Map<String, Object> map) Add all map key/value pairs to `extraParams` map.putAllMetadata
(Map<String, String> map) Add all map key/value pairs to `metadata` map.putExtraParam
(String key, Object value) Add a key/value pair to `extraParams` map.putMetadata
(String key, String value) Add a key/value pair to `metadata` map.Required. The “presentment amount” to be collected from the customer.Required. The frequency of the underlying payment.setCustomer
(String customer) Required. ID of the Customer to which this OffSessionPayment belongs.setOnBehalfOf
(String onBehalfOf) The account (if any) for which the funds of the OffSessionPayment are intended.setPaymentMethod
(String paymentMethod) Required. ID of the payment method used in this OffSessionPayment.setRetryDetails
(OffSessionPaymentCreateParams.RetryDetails retryDetails) Details about the OffSessionPayment retries.setStatementDescriptor
(String statementDescriptor) Text that appears on the customer’s statement as the statement descriptor for a non-card charge.setStatementDescriptorSuffix
(String statementDescriptorSuffix) Provides information about a card charge.setTestClock
(String testClock) Test clock that can be used to advance the retry attempts in a sandbox.setTransferData
(OffSessionPaymentCreateParams.TransferData transferData) The data that automatically creates a Transfer after the payment finalizes.
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
build
Finalize and obtain parameter instance from this builder. -
setAmount
Required. The “presentment amount” to be collected from the customer. -
setCadence
public OffSessionPaymentCreateParams.Builder setCadence(OffSessionPaymentCreateParams.Cadence cadence) Required. The frequency of the underlying payment. -
setCustomer
Required. ID of the Customer to which this OffSessionPayment belongs. -
putExtraParam
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. SeeOffSessionPaymentCreateParams.extraParams
for the field documentation. -
putAllExtraParam
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. SeeOffSessionPaymentCreateParams.extraParams
for the field documentation. -
putMetadata
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. SeeOffSessionPaymentCreateParams.metadata
for the field documentation. -
putAllMetadata
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. SeeOffSessionPaymentCreateParams.metadata
for the field documentation. -
setOnBehalfOf
The account (if any) for which the funds of the OffSessionPayment are intended. -
setPaymentMethod
Required. ID of the payment method used in this OffSessionPayment. -
setRetryDetails
public OffSessionPaymentCreateParams.Builder setRetryDetails(OffSessionPaymentCreateParams.RetryDetails retryDetails) Details about the OffSessionPayment retries. -
setStatementDescriptor
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
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.
-