Package com.stripe.model

Class PaymentAttemptRecord

java.lang.Object
com.stripe.model.StripeObject
com.stripe.net.ApiResource
com.stripe.model.PaymentAttemptRecord
All Implemented Interfaces:
HasId, StripeActiveObject, StripeObjectInterface
public class PaymentAttemptRecord extends ApiResource implements HasId
A Payment Attempt Record represents an individual attempt at making a payment, on or off Stripe. Each payment attempt tries to collect a fixed amount of money from a fixed customer and payment method. Payment Attempt Records are attached to Payment Records. Only one attempt per Payment Record can have guaranteed funds.

  • Constructor Details

    • PaymentAttemptRecord

      public PaymentAttemptRecord()

  • Method Details

    • list

      public static PaymentAttemptRecordCollection list(Map<String,Object> params) throws StripeException
      List all the Payment Attempt Records attached to the specified Payment Record.
      Throws:
      StripeException

    • list

      public static PaymentAttemptRecordCollection list(Map<String,Object> params, RequestOptions options) throws StripeException
      List all the Payment Attempt Records attached to the specified Payment Record.
      Throws:
      StripeException

    • list

      public static PaymentAttemptRecordCollection list(PaymentAttemptRecordListParams params) throws StripeException
      List all the Payment Attempt Records attached to the specified Payment Record.
      Throws:
      StripeException

    • list

      public static PaymentAttemptRecordCollection list(PaymentAttemptRecordListParams params, RequestOptions options) throws StripeException
      List all the Payment Attempt Records attached to the specified Payment Record.
      Throws:
      StripeException

    • retrieve

      public static PaymentAttemptRecord retrieve(String id) throws StripeException
      Retrieves a Payment Attempt Record with the given ID.
      Throws:
      StripeException

    • retrieve

      public static PaymentAttemptRecord retrieve(String id, RequestOptions options) throws StripeException
      Retrieves a Payment Attempt Record with the given ID.
      Throws:
      StripeException

    • retrieve

      public static PaymentAttemptRecord retrieve(String id, Map<String,Object> params, RequestOptions options) throws StripeException
      Retrieves a Payment Attempt Record with the given ID.
      Throws:
      StripeException

    • retrieve

      public static PaymentAttemptRecord retrieve(String id, PaymentAttemptRecordRetrieveParams params, RequestOptions options) throws StripeException
      Retrieves a Payment Attempt Record with the given ID.
      Throws:
      StripeException

    • setResponseGetter

      public void setResponseGetter(StripeResponseGetter responseGetter)
      Description copied from interface: StripeActiveObject
      Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
      Specified by:
      setResponseGetter in interface StripeActiveObject
      Overrides:
      setResponseGetter in class ApiResource
      Parameters:
      responseGetter - the StripeResponseGetter instance to use for making further requests.

    • getAmount

      public PaymentAttemptRecord.Amount getAmount()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountAuthorized

      public PaymentAttemptRecord.AmountAuthorized getAmountAuthorized()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountCanceled

      public PaymentAttemptRecord.AmountCanceled getAmountCanceled()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountFailed

      public PaymentAttemptRecord.AmountFailed getAmountFailed()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountGuaranteed

      public PaymentAttemptRecord.AmountGuaranteed getAmountGuaranteed()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountRefunded

      public PaymentAttemptRecord.AmountRefunded getAmountRefunded()
      A representation of an amount of money, consisting of an amount and a currency.

    • getAmountRequested

      public PaymentAttemptRecord.AmountRequested getAmountRequested()
      A representation of an amount of money, consisting of an amount and a currency.

    • getApplication

      public String getApplication()
      ID of the Connect application that created the PaymentAttemptRecord.

    • getCreated

      public Long getCreated()
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • getCustomerDetails

      public PaymentAttemptRecord.CustomerDetails getCustomerDetails()
      Customer information for this payment.

    • getCustomerPresence

      public String getCustomerPresence()
      Indicates whether the customer was present in your checkout flow during this payment.

      One of off_session, or on_session.

    • getDescription

      public String getDescription()
      An arbitrary string attached to the object. Often useful for displaying to users.

    • getLivemode

      public Boolean getLivemode()
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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

    • getObject

      public String getObject()
      String representing the object's type. Objects of the same type share the same value.

      Equal to payment_attempt_record.

    • getPaymentMethodDetails

      public PaymentAttemptRecord.PaymentMethodDetails getPaymentMethodDetails()
      Information about the Payment Method debited for this payment.

    • getPaymentRecord

      public String getPaymentRecord()
      ID of the Payment Record this Payment Attempt Record belongs to.

    • getProcessorDetails

      public PaymentAttemptRecord.ProcessorDetails getProcessorDetails()
      Processor information associated with this payment.

    • getReportedBy

      public String getReportedBy()
      Indicates who reported the payment.

      One of self, or stripe.

    • getShippingDetails

      public PaymentAttemptRecord.ShippingDetails getShippingDetails()
      Shipping information for this payment.

    • setAmount

      public void setAmount(PaymentAttemptRecord.Amount amount)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountAuthorized

      public void setAmountAuthorized(PaymentAttemptRecord.AmountAuthorized amountAuthorized)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountCanceled

      public void setAmountCanceled(PaymentAttemptRecord.AmountCanceled amountCanceled)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountFailed

      public void setAmountFailed(PaymentAttemptRecord.AmountFailed amountFailed)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountGuaranteed

      public void setAmountGuaranteed(PaymentAttemptRecord.AmountGuaranteed amountGuaranteed)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountRefunded

      public void setAmountRefunded(PaymentAttemptRecord.AmountRefunded amountRefunded)
      A representation of an amount of money, consisting of an amount and a currency.

    • setAmountRequested

      public void setAmountRequested(PaymentAttemptRecord.AmountRequested amountRequested)
      A representation of an amount of money, consisting of an amount and a currency.

    • setApplication

      public void setApplication(String application)
      ID of the Connect application that created the PaymentAttemptRecord.

    • setCreated

      public void setCreated(Long created)
      Time at which the object was created. Measured in seconds since the Unix epoch.

    • setCustomerDetails

      public void setCustomerDetails(PaymentAttemptRecord.CustomerDetails customerDetails)
      Customer information for this payment.

    • setCustomerPresence

      public void setCustomerPresence(String customerPresence)
      Indicates whether the customer was present in your checkout flow during this payment.

      One of off_session, or on_session.

    • setDescription

      public void setDescription(String description)
      An arbitrary string attached to the object. Often useful for displaying to users.

    • setId

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

    • setLivemode

      public void setLivemode(Boolean livemode)
      If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.

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

    • setObject

      public void setObject(String object)
      String representing the object's type. Objects of the same type share the same value.

      Equal to payment_attempt_record.

    • setPaymentMethodDetails

      public void setPaymentMethodDetails(PaymentAttemptRecord.PaymentMethodDetails paymentMethodDetails)
      Information about the Payment Method debited for this payment.

    • setPaymentRecord

      public void setPaymentRecord(String paymentRecord)
      ID of the Payment Record this Payment Attempt Record belongs to.

    • setProcessorDetails

      public void setProcessorDetails(PaymentAttemptRecord.ProcessorDetails processorDetails)
      Processor information associated with this payment.

    • setReportedBy

      public void setReportedBy(String reportedBy)
      Indicates who reported the payment.

      One of self, or stripe.

    • setShippingDetails

      public void setShippingDetails(PaymentAttemptRecord.ShippingDetails shippingDetails)
      Shipping information for this payment.

    • 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