Package com.stripe.param.v2.payments

Class OffSessionPaymentCreateParams

java.lang.Object
com.stripe.net.ApiRequestParams
com.stripe.param.v2.payments.OffSessionPaymentCreateParams
public class OffSessionPaymentCreateParams extends ApiRequestParams

  • Method Details

    • builder

      public static OffSessionPaymentCreateParams.Builder builder()

    • getAmount

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

    • getCadence

      public OffSessionPaymentCreateParams.Cadence getCadence()
      Required. The frequency of the underlying payment.

    • getCustomer

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

    • getExtraParams

      public Map<String,Object> getExtraParams()
      Map of extra parameters for custom features not available in this client library. The content in this map is not serialized under this field's @SerializedName value. Instead, each key/value pair is serialized as if the key is a root-level field (serialized) name in this param object. Effectively, this map is flattened to its parent instance.

    • getMetadata

      public Map<String,String> getMetadata()
      Required. 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.

    • getOnBehalfOf

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

    • getPaymentMethod

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

    • getRetryDetails

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

    • getTestClock

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

    • getTransferData

      public OffSessionPaymentCreateParams.TransferData getTransferData()
      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