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
public class OffSessionPayment extends StripeObject implements HasId
OffSessionPayment resource.

  • Constructor Details

    • OffSessionPayment

      public OffSessionPayment()

  • Method Details

    • getAmountCapturable

      public Amount getAmountCapturable()
      The amount available to be captured.

    • getAmountDetails

      public OffSessionPayment.AmountDetails getAmountDetails()
      Provides industry-specific information about the amount.

    • getAmountRequested

      public Amount getAmountRequested()
      The “presentment amount” to be collected from the customer.

    • getCadence

      public String getCadence()
      The frequency of the underlying payment.

      One of recurring, or unscheduled.

    • getCapture

      public OffSessionPayment.Capture getCapture()
      Details about the capture configuration for the OffSessionPayment.

    • getCaptureMethod

      public String getCaptureMethod()
      Whether the OffSessionPayment should be captured automatically or manually.

      One of automatic, or manual.

    • getCompartmentId

      public String getCompartmentId()
      ID of the owning compartment.

    • getCreated

      public Instant 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

      public String getCustomer()
      ID of the Customer to which this OffSessionPayment belongs.

    • getFailureReason

      public String getFailureReason()
      The reason why the OffSessionPayment failed.

      One of authorization_expired, rejected_by_partner, or retries_exhausted.

    • getLastAuthorizationAttemptError

      public String getLastAuthorizationAttemptError()
      The payment error encountered in the previous attempt to authorize the payment.

    • getLatestPaymentAttemptRecord

      public String getLatestPaymentAttemptRecord()
      Payment attempt record for the latest attempt, if one exists.

    • getLivemode

      public Boolean getLivemode()
      Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    • getMetadata

      public Map<String,String> 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

      public String 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

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

    • getPaymentMethod

      public String getPaymentMethod()
      ID of the payment method used in this OffSessionPayment.

    • getPaymentRecord

      public String getPaymentRecord()
      Payment record associated with the OffSessionPayment.

    • getPaymentsOrchestration

      public OffSessionPayment.PaymentsOrchestration getPaymentsOrchestration()
      Details about the payments orchestration configuration.

    • getRetryDetails

      public OffSessionPayment.RetryDetails getRetryDetails()
      Details about the OffSessionPayment retries.

    • getStatementDescriptor

      public String 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

      public String 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

      public String getStatus()
      Status of this OffSessionPayment, one of pending, pending_retry, processing, failed, canceled, requires_capture, or succeeded.

    • getTestClock

      public String getTestClock()
      Test clock that can be used to advance the retry attempts in a sandbox.

    • getTransferData

      public OffSessionPayment.TransferData getTransferData()
      The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts.

    • setAmountCapturable

      public void setAmountCapturable(Amount amountCapturable)
      The amount available to be captured.

    • setAmountDetails

      public void setAmountDetails(OffSessionPayment.AmountDetails amountDetails)
      Provides industry-specific information about the amount.

    • setAmountRequested

      public void setAmountRequested(Amount amountRequested)
      The “presentment amount” to be collected from the customer.

    • setCadence

      public void setCadence(String cadence)
      The frequency of the underlying payment.

      One of recurring, or unscheduled.

    • setCapture

      public void setCapture(OffSessionPayment.Capture capture)
      Details about the capture configuration for the OffSessionPayment.

    • setCaptureMethod

      public void setCaptureMethod(String captureMethod)
      Whether the OffSessionPayment should be captured automatically or manually.

      One of automatic, or manual.

    • setCompartmentId

      public void setCompartmentId(String compartmentId)
      ID of the owning compartment.

    • setCreated

      public void setCreated(Instant created)
      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

      public void setCustomer(String customer)
      ID of the Customer to which this OffSessionPayment belongs.

    • setFailureReason

      public void setFailureReason(String failureReason)
      The reason why the OffSessionPayment failed.

      One of authorization_expired, rejected_by_partner, or retries_exhausted.

    • setId

      public void setId(String id)
      Unique identifier for the object.

    • setLastAuthorizationAttemptError

      public void setLastAuthorizationAttemptError(String lastAuthorizationAttemptError)
      The payment error encountered in the previous attempt to authorize the payment.

    • setLatestPaymentAttemptRecord

      public void setLatestPaymentAttemptRecord(String latestPaymentAttemptRecord)
      Payment attempt record for the latest attempt, if one exists.

    • setLivemode

      public 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.

    • setMetadata

      public void setMetadata(Map<String,String> metadata)
      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

      public void setObject(String object)
      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

      public void setOnBehalfOf(String onBehalfOf)
      The account (if any) for which the funds of the OffSessionPayment are intended.

    • setPaymentMethod

      public void setPaymentMethod(String paymentMethod)
      ID of the payment method used in this OffSessionPayment.

    • setPaymentRecord

      public void setPaymentRecord(String paymentRecord)
      Payment record associated with the OffSessionPayment.

    • setPaymentsOrchestration

      public void setPaymentsOrchestration(OffSessionPayment.PaymentsOrchestration paymentsOrchestration)
      Details about the payments orchestration configuration.

    • setRetryDetails

      public void setRetryDetails(OffSessionPayment.RetryDetails retryDetails)
      Details about the OffSessionPayment retries.

    • setStatementDescriptor

      public void 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 void 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.

    • setStatus

      public void setStatus(String status)
      Status of this OffSessionPayment, one of pending, pending_retry, processing, failed, canceled, requires_capture, or succeeded.

    • setTestClock

      public void setTestClock(String testClock)
      Test clock that can be used to advance the retry attempts in a sandbox.

    • setTransferData

      public void setTransferData(OffSessionPayment.TransferData transferData)
      The data that automatically creates a Transfer after the payment finalizes. Learn more about the use case for connected accounts.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • getId

      public String getId()
      Unique identifier for the object.
      Specified by:
      getId in interface HasId