Package com.stripe.model.v2.payments
Class OffSessionPayment
java.lang.Object
com.stripe.model.StripeObject
com.stripe.model.v2.payments.OffSessionPayment
- All Implemented Interfaces:
HasId
,StripeObjectInterface
OffSessionPayment resource.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic class
Provides industry-specific information about the amount.static class
Details about the capture configuration for the OffSessionPayment.static class
Details about the payments orchestration configuration.static class
Details about the OffSessionPayment retries.static class
The data that automatically creates a Transfer after the payment finalizes. -
Field Summary
Fields inherited from class com.stripe.model.StripeObject
PRETTY_PRINT_GSON
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
boolean
The amount available to be captured.Provides industry-specific information about the amount.The “presentment amount” to be collected from the customer.The frequency of the underlying payment.Details about the capture configuration for the OffSessionPayment.Whether the OffSessionPayment should be captured automatically or manually.ID of the owning compartment.Creation time of the OffSessionPayment.ID of the Customer to which this OffSessionPayment belongs.The reason why the OffSessionPayment failed.getId()
Unique identifier for the object.The payment error encountered in the previous attempt to authorize the payment.Payment attempt record for the latest attempt, if one exists.Has the value true if the object exists in live mode or the value false if the object exists in test mode.Set of key-value pairs that you can attach to an object.String representing the object's type.The account (if any) for which the funds of the OffSessionPayment are intended.ID of the payment method used in this OffSessionPayment.Payment record associated with the OffSessionPayment.Details about the payments orchestration configuration.Details about the OffSessionPayment retries.Text that appears on the customer’s statement as the statement descriptor for a non-card charge.Provides information about a card charge.Status of this OffSessionPayment, one ofpending
,pending_retry
,processing
,failed
,canceled
,requires_capture
, orsucceeded
.Test clock that can be used to advance the retry attempts in a sandbox.The data that automatically creates a Transfer after the payment finalizes.int
hashCode()
void
setAmountCapturable
(Amount amountCapturable) The amount available to be captured.void
setAmountDetails
(OffSessionPayment.AmountDetails amountDetails) Provides industry-specific information about the amount.void
setAmountRequested
(Amount amountRequested) The “presentment amount” to be collected from the customer.void
setCadence
(String cadence) The frequency of the underlying payment.void
setCapture
(OffSessionPayment.Capture capture) Details about the capture configuration for the OffSessionPayment.void
setCaptureMethod
(String captureMethod) Whether the OffSessionPayment should be captured automatically or manually.void
setCompartmentId
(String compartmentId) ID of the owning compartment.void
setCreated
(Instant created) Creation time of the OffSessionPayment.void
setCustomer
(String customer) ID of the Customer to which this OffSessionPayment belongs.void
setFailureReason
(String failureReason) The reason why the OffSessionPayment failed.void
Unique identifier for the object.void
setLastAuthorizationAttemptError
(String lastAuthorizationAttemptError) The payment error encountered in the previous attempt to authorize the payment.void
setLatestPaymentAttemptRecord
(String latestPaymentAttemptRecord) Payment attempt record for the latest attempt, if one exists.void
setLivemode
(Boolean livemode) Has the value true if the object exists in live mode or the value false if the object exists in test mode.void
setMetadata
(Map<String, String> metadata) Set of key-value pairs that you can attach to an object.void
String representing the object's type.void
setOnBehalfOf
(String onBehalfOf) The account (if any) for which the funds of the OffSessionPayment are intended.void
setPaymentMethod
(String paymentMethod) ID of the payment method used in this OffSessionPayment.void
setPaymentRecord
(String paymentRecord) Payment record associated with the OffSessionPayment.void
setPaymentsOrchestration
(OffSessionPayment.PaymentsOrchestration paymentsOrchestration) Details about the payments orchestration configuration.void
setRetryDetails
(OffSessionPayment.RetryDetails retryDetails) Details about the OffSessionPayment retries.void
setStatementDescriptor
(String statementDescriptor) Text that appears on the customer’s statement as the statement descriptor for a non-card charge.void
setStatementDescriptorSuffix
(String statementDescriptorSuffix) Provides information about a card charge.void
Status of this OffSessionPayment, one ofpending
,pending_retry
,processing
,failed
,canceled
,requires_capture
, orsucceeded
.void
setTestClock
(String testClock) Test clock that can be used to advance the retry attempts in a sandbox.void
setTransferData
(OffSessionPayment.TransferData transferData) The data that automatically creates a Transfer after the payment finalizes.Methods inherited from class com.stripe.model.StripeObject
deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString
-
Constructor Details
-
OffSessionPayment
public OffSessionPayment()
-
-
Method Details
-
getAmountCapturable
The amount available to be captured. -
getAmountDetails
Provides industry-specific information about the amount. -
getAmountRequested
The “presentment amount” to be collected from the customer. -
getCadence
The frequency of the underlying payment.One of
recurring
, orunscheduled
. -
getCapture
Details about the capture configuration for the OffSessionPayment. -
getCaptureMethod
Whether the OffSessionPayment should be captured automatically or manually.One of
automatic
, ormanual
. -
getCompartmentId
ID of the owning compartment. -
getCreated
Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
getCustomer
ID of the Customer to which this OffSessionPayment belongs. -
getFailureReason
The reason why the OffSessionPayment failed.One of
authorization_expired
,rejected_by_partner
, orretries_exhausted
. -
getLastAuthorizationAttemptError
The payment error encountered in the previous attempt to authorize the payment. -
getLatestPaymentAttemptRecord
Payment attempt record for the latest attempt, if one exists. -
getLivemode
Has the value true if the object exists in live mode or the value false if the object exists in test mode. -
getMetadata
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. Learn more about storing information in metadata. -
getObject
String representing the object's type. Objects of the same type share the same value of the object field.Equal to
v2.payments.off_session_payment
. -
getOnBehalfOf
The account (if any) for which the funds of the OffSessionPayment are intended. -
getPaymentMethod
ID of the payment method used in this OffSessionPayment. -
getPaymentRecord
Payment record associated with the OffSessionPayment. -
getPaymentsOrchestration
Details about the payments orchestration configuration. -
getRetryDetails
Details about the OffSessionPayment retries. -
getStatementDescriptor
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. -
getStatementDescriptorSuffix
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. -
getStatus
Status of this OffSessionPayment, one ofpending
,pending_retry
,processing
,failed
,canceled
,requires_capture
, orsucceeded
. -
getTestClock
Test clock that can be used to advance the retry attempts in a sandbox. -
getTransferData
The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts. -
setAmountCapturable
The amount available to be captured. -
setAmountDetails
Provides industry-specific information about the amount. -
setAmountRequested
The “presentment amount” to be collected from the customer. -
setCadence
The frequency of the underlying payment.One of
recurring
, orunscheduled
. -
setCapture
Details about the capture configuration for the OffSessionPayment. -
setCaptureMethod
Whether the OffSessionPayment should be captured automatically or manually.One of
automatic
, ormanual
. -
setCompartmentId
ID of the owning compartment. -
setCreated
Creation time of the OffSessionPayment. Represented as a RFC 3339 date & time UTC value in millisecond precision, for example: 2022-09-18T13:22:18.123Z. -
setCustomer
ID of the Customer to which this OffSessionPayment belongs. -
setFailureReason
The reason why the OffSessionPayment failed.One of
authorization_expired
,rejected_by_partner
, orretries_exhausted
. -
setId
Unique identifier for the object. -
setLastAuthorizationAttemptError
The payment error encountered in the previous attempt to authorize the payment. -
setLatestPaymentAttemptRecord
Payment attempt record for the latest attempt, if one exists. -
setLivemode
Has the value true if the object exists in live mode or the value false if the object exists in test mode. -
setMetadata
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. Learn more about storing information in metadata. -
setObject
String representing the object's type. Objects of the same type share the same value of the object field.Equal to
v2.payments.off_session_payment
. -
setOnBehalfOf
The account (if any) for which the funds of the OffSessionPayment are intended. -
setPaymentMethod
ID of the payment method used in this OffSessionPayment. -
setPaymentRecord
Payment record associated with the OffSessionPayment. -
setPaymentsOrchestration
Details about the payments orchestration configuration. -
setRetryDetails
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
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. -
setStatus
Status of this OffSessionPayment, one ofpending
,pending_retry
,processing
,failed
,canceled
,requires_capture
, orsucceeded
. -
setTestClock
Test clock that can be used to advance the retry attempts in a sandbox. -
setTransferData
The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts. -
equals
-
canEqual
-
hashCode
public int hashCode() -
getId
Unique identifier for the object.
-