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.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentAttemptRecord.Amount	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountAuthorized	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountCanceled	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountFailed	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountGuaranteed	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountRefunded	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.AmountRequested	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentAttemptRecord.CustomerDetails	Information about the customer for this payment.
static class	PaymentAttemptRecord.PaymentMethodDetails	Details about the Payment Method used in this payment attempt.
static class	PaymentAttemptRecord.ProcessorDetails	Processor information associated with this payment.
static class	PaymentAttemptRecord.ShippingDetails	The customer's shipping information associated with this payment.

Nested classes/interfaces inherited from class com.stripe.net.ApiResource

ApiResource.RequestMethod

Field Summary

Fields inherited from class com.stripe.net.ApiResource

CHARSET, GSON, INTERNAL_GSON

Fields inherited from class com.stripe.model.StripeObject

PRETTY_PRINT_GSON

Constructor Summary

Constructors

Constructor	Description
PaymentAttemptRecord()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PaymentAttemptRecord.Amount	getAmount()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountAuthorized	getAmountAuthorized()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountCanceled	getAmountCanceled()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountFailed	getAmountFailed()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountGuaranteed	getAmountGuaranteed()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountRefunded	getAmountRefunded()	A representation of an amount of money, consisting of an amount and a currency.
PaymentAttemptRecord.AmountRequested	getAmountRequested()	A representation of an amount of money, consisting of an amount and a currency.
String	getApplication()	ID of the Connect application that created the PaymentAttemptRecord.
Long	getCreated()	Time at which the object was created.
PaymentAttemptRecord.CustomerDetails	getCustomerDetails()	Customer information for this payment.
String	getCustomerPresence()	Indicates whether the customer was present in your checkout flow during this payment.
String	getDescription()	An arbitrary string attached to the object.
String	getId()	Unique identifier for the object.
Boolean	getLivemode()	Has the value true if the object exists in live mode or the value false if the object exists in test mode.
Map<String,String>	getMetadata()	Set of key-value pairs that you can attach to an object.
String	getObject()	String representing the object's type.
PaymentAttemptRecord.PaymentMethodDetails	getPaymentMethodDetails()	Information about the Payment Method debited for this payment.
String	getPaymentRecord()	ID of the Payment Record this Payment Attempt Record belongs to.
PaymentAttemptRecord.ProcessorDetails	getProcessorDetails()	Processor information associated with this payment.
String	getReportedBy()	Indicates who reported the payment.
PaymentAttemptRecord.ShippingDetails	getShippingDetails()	Shipping information for this payment.
int	hashCode()
static PaymentAttemptRecordCollection	list(PaymentAttemptRecordListParams params)	List all the Payment Attempt Records attached to the specified Payment Record.
static PaymentAttemptRecordCollection	list(PaymentAttemptRecordListParams params, RequestOptions options)	List all the Payment Attempt Records attached to the specified Payment Record.
static PaymentAttemptRecordCollection	list(Map<String,Object> params)	List all the Payment Attempt Records attached to the specified Payment Record.
static PaymentAttemptRecordCollection	list(Map<String,Object> params, RequestOptions options)	List all the Payment Attempt Records attached to the specified Payment Record.
static PaymentAttemptRecord	retrieve(String id)	Retrieves a Payment Attempt Record with the given ID.
static PaymentAttemptRecord	retrieve(String id, RequestOptions options)	Retrieves a Payment Attempt Record with the given ID.
static PaymentAttemptRecord	retrieve(String id, PaymentAttemptRecordRetrieveParams params, RequestOptions options)	Retrieves a Payment Attempt Record with the given ID.
static PaymentAttemptRecord	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a Payment Attempt Record with the given ID.
void	setAmount(PaymentAttemptRecord.Amount amount)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountAuthorized(PaymentAttemptRecord.AmountAuthorized amountAuthorized)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountCanceled(PaymentAttemptRecord.AmountCanceled amountCanceled)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountFailed(PaymentAttemptRecord.AmountFailed amountFailed)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountGuaranteed(PaymentAttemptRecord.AmountGuaranteed amountGuaranteed)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountRefunded(PaymentAttemptRecord.AmountRefunded amountRefunded)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountRequested(PaymentAttemptRecord.AmountRequested amountRequested)	A representation of an amount of money, consisting of an amount and a currency.
void	setApplication(String application)	ID of the Connect application that created the PaymentAttemptRecord.
void	setCreated(Long created)	Time at which the object was created.
void	setCustomerDetails(PaymentAttemptRecord.CustomerDetails customerDetails)	Customer information for this payment.
void	setCustomerPresence(String customerPresence)	Indicates whether the customer was present in your checkout flow during this payment.
void	setDescription(String description)	An arbitrary string attached to the object.
void	setId(String id)	Unique identifier for the object.
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	setObject(String object)	String representing the object's type.
void	setPaymentMethodDetails(PaymentAttemptRecord.PaymentMethodDetails paymentMethodDetails)	Information about the Payment Method debited for this payment.
void	setPaymentRecord(String paymentRecord)	ID of the Payment Record this Payment Attempt Record belongs to.
void	setProcessorDetails(PaymentAttemptRecord.ProcessorDetails processorDetails)	Processor information associated with this payment.
void	setReportedBy(String reportedBy)	Indicates who reported the payment.
void	setResponseGetter(StripeResponseGetter responseGetter)	State, county, province, or region.
void	setShippingDetails(PaymentAttemptRecord.ShippingDetails shippingDetails)	Shipping information for this payment.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setGlobalResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, deserializeStripeObject, equals, getLastResponse, getRawJsonObject, setLastResponse, toJson, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.stripe.model.StripeActiveObject

trySetResponseGetter

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)

State, county, province, or region.

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()

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.

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)

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.

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