Package com.stripe.model

Class PaymentRecord

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.PaymentRecord

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class PaymentRecord
extends ApiResource
implements HasId

A Payment Record is a resource that allows you to represent payments that occur on- or off-Stripe. For example, you can create a Payment Record to model a payment made on a different payment processor, in order to mark an Invoice as paid and a Subscription as active. Payment Records consist of one or more Payment Attempt Records, which represent individual attempts made on a payment network.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PaymentRecord.Amount	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountAuthorized	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountCanceled	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountFailed	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountGuaranteed	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountRefunded	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.AmountRequested	A representation of an amount of money, consisting of an amount and a currency.
static class	PaymentRecord.CustomerDetails	Information about the customer for this payment.
static class	PaymentRecord.PaymentMethodDetails	Details about the Payment Method used in this payment attempt.
static class	PaymentRecord.ProcessorDetails	Processor information associated with this payment.
static class	PaymentRecord.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
PaymentRecord()

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
boolean	equals(Object o)
PaymentRecord.Amount	getAmount()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.AmountAuthorized	getAmountAuthorized()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.AmountCanceled	getAmountCanceled()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.AmountFailed	getAmountFailed()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.AmountGuaranteed	getAmountGuaranteed()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.AmountRefunded	getAmountRefunded()	A representation of an amount of money, consisting of an amount and a currency.
PaymentRecord.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 PaymentRecord.
Long	getCreated()	Time at which the object was created.
PaymentRecord.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.
String	getLatestPaymentAttemptRecord()	ID of the latest Payment Attempt Record attached to this Payment Record.
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.
PaymentRecord.PaymentMethodDetails	getPaymentMethodDetails()	Information about the Payment Method debited for this payment.
PaymentRecord.ProcessorDetails	getProcessorDetails()	Processor information associated with this payment.
PaymentRecord.ShippingDetails	getShippingDetails()	Shipping information for this payment.
int	hashCode()
static PaymentRecord	reportPayment(PaymentRecordReportPaymentParams params)	Report a new Payment Record.
static PaymentRecord	reportPayment(PaymentRecordReportPaymentParams params, RequestOptions options)	Report a new Payment Record.
static PaymentRecord	reportPayment(Map<String,Object> params)	Report a new Payment Record.
static PaymentRecord	reportPayment(Map<String,Object> params, RequestOptions options)	Report a new Payment Record.
PaymentRecord	reportPaymentAttempt(PaymentRecordReportPaymentAttemptParams params)	Report a new payment attempt on the specified Payment Record.
PaymentRecord	reportPaymentAttempt(PaymentRecordReportPaymentAttemptParams params, RequestOptions options)	Report a new payment attempt on the specified Payment Record.
PaymentRecord	reportPaymentAttempt(Map<String,Object> params)	Report a new payment attempt on the specified Payment Record.
PaymentRecord	reportPaymentAttempt(Map<String,Object> params, RequestOptions options)	Report a new payment attempt on the specified Payment Record.
PaymentRecord	reportPaymentAttemptCanceled(PaymentRecordReportPaymentAttemptCanceledParams params)	Report that the most recent payment attempt on the specified Payment Record was canceled.
PaymentRecord	reportPaymentAttemptCanceled(PaymentRecordReportPaymentAttemptCanceledParams params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record was canceled.
PaymentRecord	reportPaymentAttemptCanceled(Map<String,Object> params)	Report that the most recent payment attempt on the specified Payment Record was canceled.
PaymentRecord	reportPaymentAttemptCanceled(Map<String,Object> params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record was canceled.
PaymentRecord	reportPaymentAttemptFailed(PaymentRecordReportPaymentAttemptFailedParams params)	Report that the most recent payment attempt on the specified Payment Record failed or errored.
PaymentRecord	reportPaymentAttemptFailed(PaymentRecordReportPaymentAttemptFailedParams params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record failed or errored.
PaymentRecord	reportPaymentAttemptFailed(Map<String,Object> params)	Report that the most recent payment attempt on the specified Payment Record failed or errored.
PaymentRecord	reportPaymentAttemptFailed(Map<String,Object> params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record failed or errored.
PaymentRecord	reportPaymentAttemptGuaranteed(PaymentRecordReportPaymentAttemptGuaranteedParams params)	Report that the most recent payment attempt on the specified Payment Record was guaranteed.
PaymentRecord	reportPaymentAttemptGuaranteed(PaymentRecordReportPaymentAttemptGuaranteedParams params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record was guaranteed.
PaymentRecord	reportPaymentAttemptGuaranteed(Map<String,Object> params)	Report that the most recent payment attempt on the specified Payment Record was guaranteed.
PaymentRecord	reportPaymentAttemptGuaranteed(Map<String,Object> params, RequestOptions options)	Report that the most recent payment attempt on the specified Payment Record was guaranteed.
static PaymentRecord	retrieve(String id)	Retrieves a Payment Record with the given ID.
static PaymentRecord	retrieve(String id, RequestOptions options)	Retrieves a Payment Record with the given ID.
static PaymentRecord	retrieve(String id, PaymentRecordRetrieveParams params, RequestOptions options)	Retrieves a Payment Record with the given ID.
static PaymentRecord	retrieve(String id, Map<String,Object> params, RequestOptions options)	Retrieves a Payment Record with the given ID.
void	setAmount(PaymentRecord.Amount amount)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountAuthorized(PaymentRecord.AmountAuthorized amountAuthorized)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountCanceled(PaymentRecord.AmountCanceled amountCanceled)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountFailed(PaymentRecord.AmountFailed amountFailed)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountGuaranteed(PaymentRecord.AmountGuaranteed amountGuaranteed)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountRefunded(PaymentRecord.AmountRefunded amountRefunded)	A representation of an amount of money, consisting of an amount and a currency.
void	setAmountRequested(PaymentRecord.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 PaymentRecord.
void	setCreated(Long created)	Time at which the object was created.
void	setCustomerDetails(PaymentRecord.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	setLatestPaymentAttemptRecord(String latestPaymentAttemptRecord)	ID of the latest Payment Attempt Record attached to this Payment Record.
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(PaymentRecord.PaymentMethodDetails paymentMethodDetails)	Information about the Payment Method debited for this payment.
void	setProcessorDetails(PaymentRecord.ProcessorDetails processorDetails)	Processor information associated with this payment.
void	setResponseGetter(StripeResponseGetter responseGetter)	State, county, province, or region.
void	setShippingDetails(PaymentRecord.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

PaymentRecord

public PaymentRecord()

Method Details

reportPayment

public static PaymentRecord reportPayment(Map<String,Object> params)
                                   throws StripeException

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

Throws:

StripeException

reportPayment

public static PaymentRecord reportPayment(Map<String,Object> params,
 RequestOptions options)
                                   throws StripeException

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

Throws:

StripeException

reportPayment

public static PaymentRecord reportPayment(PaymentRecordReportPaymentParams params)
                                   throws StripeException

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

Throws:

StripeException

reportPayment

public static PaymentRecord reportPayment(PaymentRecordReportPaymentParams params,
 RequestOptions options)
                                   throws StripeException

Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.

Throws:

StripeException

reportPaymentAttempt

public PaymentRecord reportPaymentAttempt(Map<String,Object> params)
                                   throws StripeException

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

Throws:

StripeException

reportPaymentAttempt

public PaymentRecord reportPaymentAttempt(Map<String,Object> params,
 RequestOptions options)
                                   throws StripeException

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

Throws:

StripeException

reportPaymentAttempt

public PaymentRecord reportPaymentAttempt(PaymentRecordReportPaymentAttemptParams params)
                                   throws StripeException

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

Throws:

StripeException

reportPaymentAttempt

public PaymentRecord reportPaymentAttempt(PaymentRecordReportPaymentAttemptParams params,
 RequestOptions options)
                                   throws StripeException

Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.

Throws:

StripeException

reportPaymentAttemptCanceled

public PaymentRecord reportPaymentAttemptCanceled(Map<String,Object> params)
                                           throws StripeException

Report that the most recent payment attempt on the specified Payment Record was canceled.

Throws:

StripeException

reportPaymentAttemptCanceled

public PaymentRecord reportPaymentAttemptCanceled(Map<String,Object> params,
 RequestOptions options)
                                           throws StripeException

Report that the most recent payment attempt on the specified Payment Record was canceled.

Throws:

StripeException

reportPaymentAttemptCanceled

public PaymentRecord reportPaymentAttemptCanceled(PaymentRecordReportPaymentAttemptCanceledParams params)
                                           throws StripeException

Report that the most recent payment attempt on the specified Payment Record was canceled.

Throws:

StripeException

reportPaymentAttemptCanceled

public PaymentRecord reportPaymentAttemptCanceled(PaymentRecordReportPaymentAttemptCanceledParams params,
 RequestOptions options)
                                           throws StripeException

Report that the most recent payment attempt on the specified Payment Record was canceled.

Throws:

StripeException

reportPaymentAttemptFailed

public PaymentRecord reportPaymentAttemptFailed(Map<String,Object> params)
                                         throws StripeException

Report that the most recent payment attempt on the specified Payment Record failed or errored.

Throws:

StripeException

reportPaymentAttemptFailed

public PaymentRecord reportPaymentAttemptFailed(Map<String,Object> params,
 RequestOptions options)
                                         throws StripeException

Report that the most recent payment attempt on the specified Payment Record failed or errored.

Throws:

StripeException

reportPaymentAttemptFailed

public PaymentRecord reportPaymentAttemptFailed(PaymentRecordReportPaymentAttemptFailedParams params)
                                         throws StripeException

Report that the most recent payment attempt on the specified Payment Record failed or errored.

Throws:

StripeException

reportPaymentAttemptFailed

public PaymentRecord reportPaymentAttemptFailed(PaymentRecordReportPaymentAttemptFailedParams params,
 RequestOptions options)
                                         throws StripeException

Report that the most recent payment attempt on the specified Payment Record failed or errored.

Throws:

StripeException

reportPaymentAttemptGuaranteed

public PaymentRecord reportPaymentAttemptGuaranteed(Map<String,Object> params)
                                             throws StripeException

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

Throws:

StripeException

reportPaymentAttemptGuaranteed

public PaymentRecord reportPaymentAttemptGuaranteed(Map<String,Object> params,
 RequestOptions options)
                                             throws StripeException

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

Throws:

StripeException

reportPaymentAttemptGuaranteed

public PaymentRecord reportPaymentAttemptGuaranteed(PaymentRecordReportPaymentAttemptGuaranteedParams params)
                                             throws StripeException

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

Throws:

StripeException

reportPaymentAttemptGuaranteed

public PaymentRecord reportPaymentAttemptGuaranteed(PaymentRecordReportPaymentAttemptGuaranteedParams params,
 RequestOptions options)
                                             throws StripeException

Report that the most recent payment attempt on the specified Payment Record was guaranteed.

Throws:

StripeException

retrieve

public static PaymentRecord retrieve(String id)
                              throws StripeException

Retrieves a Payment Record with the given ID.

Throws:

StripeException

retrieve

public static PaymentRecord retrieve(String id,
 RequestOptions options)
                              throws StripeException

Retrieves a Payment Record with the given ID.

Throws:

StripeException

retrieve

public static PaymentRecord retrieve(String id,
 Map<String,Object> params,
 RequestOptions options)
                              throws StripeException

Retrieves a Payment Record with the given ID.

Throws:

StripeException

retrieve

public static PaymentRecord retrieve(String id,
 PaymentRecordRetrieveParams params,
 RequestOptions options)
                              throws StripeException

Retrieves a Payment 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 PaymentRecord.Amount getAmount()

A representation of an amount of money, consisting of an amount and a currency.

getAmountAuthorized

public PaymentRecord.AmountAuthorized getAmountAuthorized()

A representation of an amount of money, consisting of an amount and a currency.

getAmountCanceled

public PaymentRecord.AmountCanceled getAmountCanceled()

A representation of an amount of money, consisting of an amount and a currency.

getAmountFailed

public PaymentRecord.AmountFailed getAmountFailed()

A representation of an amount of money, consisting of an amount and a currency.

getAmountGuaranteed

public PaymentRecord.AmountGuaranteed getAmountGuaranteed()

A representation of an amount of money, consisting of an amount and a currency.

getAmountRefunded

public PaymentRecord.AmountRefunded getAmountRefunded()

A representation of an amount of money, consisting of an amount and a currency.

getAmountRequested

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

getCreated

public Long getCreated()

Time at which the object was created. Measured in seconds since the Unix epoch.

getCustomerDetails

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

getLatestPaymentAttemptRecord

public String getLatestPaymentAttemptRecord()

ID of the latest Payment Attempt Record attached to this Payment Record.

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

getPaymentMethodDetails

public PaymentRecord.PaymentMethodDetails getPaymentMethodDetails()

Information about the Payment Method debited for this payment.

getProcessorDetails

public PaymentRecord.ProcessorDetails getProcessorDetails()

Processor information associated with this payment.

getShippingDetails

public PaymentRecord.ShippingDetails getShippingDetails()

Shipping information for this payment.

setAmount

public void setAmount(PaymentRecord.Amount amount)

A representation of an amount of money, consisting of an amount and a currency.

setAmountAuthorized

public void setAmountAuthorized(PaymentRecord.AmountAuthorized amountAuthorized)

A representation of an amount of money, consisting of an amount and a currency.

setAmountCanceled

public void setAmountCanceled(PaymentRecord.AmountCanceled amountCanceled)

A representation of an amount of money, consisting of an amount and a currency.

setAmountFailed

public void setAmountFailed(PaymentRecord.AmountFailed amountFailed)

A representation of an amount of money, consisting of an amount and a currency.

setAmountGuaranteed

public void setAmountGuaranteed(PaymentRecord.AmountGuaranteed amountGuaranteed)

A representation of an amount of money, consisting of an amount and a currency.

setAmountRefunded

public void setAmountRefunded(PaymentRecord.AmountRefunded amountRefunded)

A representation of an amount of money, consisting of an amount and a currency.

setAmountRequested

public void setAmountRequested(PaymentRecord.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 PaymentRecord.

setCreated

public void setCreated(Long created)

Time at which the object was created. Measured in seconds since the Unix epoch.

setCustomerDetails

public void setCustomerDetails(PaymentRecord.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.

setLatestPaymentAttemptRecord

public void setLatestPaymentAttemptRecord(String latestPaymentAttemptRecord)

ID of the latest Payment Attempt Record attached to this Payment Record.

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

setPaymentMethodDetails

public void setPaymentMethodDetails(PaymentRecord.PaymentMethodDetails paymentMethodDetails)

Information about the Payment Method debited for this payment.

setProcessorDetails

public void setProcessorDetails(PaymentRecord.ProcessorDetails processorDetails)

Processor information associated with this payment.

setShippingDetails

public void setShippingDetails(PaymentRecord.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