Package com.stripe.model.issuing

Class CreditUnderwritingRecord

java.lang.Object

com.stripe.model.StripeObject

com.stripe.net.ApiResource

com.stripe.model.issuing.CreditUnderwritingRecord

All Implemented Interfaces:

HasId, StripeActiveObject, StripeObjectInterface

public class CreditUnderwritingRecord
extends ApiResource
implements HasId

Every time an applicant submits an application for a Charge Card product your platform offers, or every time your platform takes a proactive credit decision on an existing account, you must record the decision by creating a new CreditUnderwritingRecord object on a connected account.

Follow the guide to learn about your requirements as a platform.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreditUnderwritingRecord.Application
static class	CreditUnderwritingRecord.CreditUser
static class	CreditUnderwritingRecord.Decision
static class	CreditUnderwritingRecord.UnderwritingException	List of reasons why the existing account was closed, up to 4 reasons, in order of importance.

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

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
CreditUnderwritingRecord	correct()	Update a CreditUnderwritingRecord object to correct mistakes.
CreditUnderwritingRecord	correct(RequestOptions options)	Update a CreditUnderwritingRecord object to correct mistakes.
CreditUnderwritingRecord	correct(CreditUnderwritingRecordCorrectParams params)	Update a CreditUnderwritingRecord object to correct mistakes.
CreditUnderwritingRecord	correct(CreditUnderwritingRecordCorrectParams params, RequestOptions options)	Update a CreditUnderwritingRecord object to correct mistakes.
CreditUnderwritingRecord	correct(Map<String,Object> params)	Update a CreditUnderwritingRecord object to correct mistakes.
CreditUnderwritingRecord	correct(Map<String,Object> params, RequestOptions options)	Update a CreditUnderwritingRecord object to correct mistakes.
static CreditUnderwritingRecord	createFromApplication(CreditUnderwritingRecordCreateFromApplicationParams params)	Creates a CreditUnderwritingRecord object with information about a credit application submission.
static CreditUnderwritingRecord	createFromApplication(CreditUnderwritingRecordCreateFromApplicationParams params, RequestOptions options)	Creates a CreditUnderwritingRecord object with information about a credit application submission.
static CreditUnderwritingRecord	createFromApplication(Map<String,Object> params)	Creates a CreditUnderwritingRecord object with information about a credit application submission.
static CreditUnderwritingRecord	createFromApplication(Map<String,Object> params, RequestOptions options)	Creates a CreditUnderwritingRecord object with information about a credit application submission.
static CreditUnderwritingRecord	createFromProactiveReview(CreditUnderwritingRecordCreateFromProactiveReviewParams params)	Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
static CreditUnderwritingRecord	createFromProactiveReview(CreditUnderwritingRecordCreateFromProactiveReviewParams params, RequestOptions options)	Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
static CreditUnderwritingRecord	createFromProactiveReview(Map<String,Object> params)	Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
static CreditUnderwritingRecord	createFromProactiveReview(Map<String,Object> params, RequestOptions options)	Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.
boolean	equals(Object o)
CreditUnderwritingRecord.Application	getApplication()	For decisions triggered by an application, details about the submission.
Long	getCreated()	Time at which the object was created.
String	getCreatedFrom()	The event that triggered the underwriting.
CreditUnderwritingRecord.CreditUser	getCreditUser()
Long	getDecidedAt()	Date when a decision was made.
CreditUnderwritingRecord.Decision	getDecision()	Details about the decision.
Long	getDecisionDeadline()	For underwriting initiated by an application, a decision must be taken 30 days after the submission.
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.
String	getRegulatoryReportingFile()	File containing regulatory reporting data for the decision.
CreditUnderwritingRecord.UnderwritingException	getUnderwritingException()	If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided.
int	hashCode()
static CreditUnderwritingRecordCollection	list(CreditUnderwritingRecordListParams params)	Retrieves a list of CreditUnderwritingRecord objects.
static CreditUnderwritingRecordCollection	list(CreditUnderwritingRecordListParams params, RequestOptions options)	Retrieves a list of CreditUnderwritingRecord objects.
static CreditUnderwritingRecordCollection	list(Map<String,Object> params)	Retrieves a list of CreditUnderwritingRecord objects.
static CreditUnderwritingRecordCollection	list(Map<String,Object> params, RequestOptions options)	Retrieves a list of CreditUnderwritingRecord objects.
CreditUnderwritingRecord	reportDecision(CreditUnderwritingRecordReportDecisionParams params)	Update a CreditUnderwritingRecord object from a decision made on a credit application.
CreditUnderwritingRecord	reportDecision(CreditUnderwritingRecordReportDecisionParams params, RequestOptions options)	Update a CreditUnderwritingRecord object from a decision made on a credit application.
CreditUnderwritingRecord	reportDecision(Map<String,Object> params)	Update a CreditUnderwritingRecord object from a decision made on a credit application.
CreditUnderwritingRecord	reportDecision(Map<String,Object> params, RequestOptions options)	Update a CreditUnderwritingRecord object from a decision made on a credit application.
static CreditUnderwritingRecord	retrieve(String creditUnderwritingRecord)	Retrieves a CreditUnderwritingRecord object.
static CreditUnderwritingRecord	retrieve(String creditUnderwritingRecord, RequestOptions options)	Retrieves a CreditUnderwritingRecord object.
static CreditUnderwritingRecord	retrieve(String creditUnderwritingRecord, CreditUnderwritingRecordRetrieveParams params, RequestOptions options)	Retrieves a CreditUnderwritingRecord object.
static CreditUnderwritingRecord	retrieve(String creditUnderwritingRecord, Map<String,Object> params, RequestOptions options)	Retrieves a CreditUnderwritingRecord object.
void	setApplication(CreditUnderwritingRecord.Application application)	For decisions triggered by an application, details about the submission.
void	setCreated(Long created)	Time at which the object was created.
void	setCreatedFrom(String createdFrom)	The event that triggered the underwriting.
void	setCreditUser(CreditUnderwritingRecord.CreditUser creditUser)
void	setDecidedAt(Long decidedAt)	Date when a decision was made.
void	setDecision(CreditUnderwritingRecord.Decision decision)	Details about the decision.
void	setDecisionDeadline(Long decisionDeadline)	For underwriting initiated by an application, a decision must be taken 30 days after the submission.
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	setRegulatoryReportingFile(String regulatoryReportingFile)	File containing regulatory reporting data for the decision.
void	setResponseGetter(StripeResponseGetter responseGetter)	Method is used by the containing object or StripeResponseGetter implementations to set the StripeResponseGetter instance used to make further requests.
void	setUnderwritingException(CreditUnderwritingRecord.UnderwritingException underwritingException)	If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided.

Methods inherited from class com.stripe.net.ApiResource

checkNullTypedParams, getGlobalResponseGetter, getResponseGetter, setExpandableFieldId, setStripeResponseGetter, urlEncode, urlEncodeId

Methods inherited from class com.stripe.model.StripeObject

deserializeStripeObject, 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

CreditUnderwritingRecord

public CreditUnderwritingRecord()

Method Details

correct

public CreditUnderwritingRecord correct()
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

correct

public CreditUnderwritingRecord correct(RequestOptions options)
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

correct

public CreditUnderwritingRecord correct(Map<String,Object> params)
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

correct

public CreditUnderwritingRecord correct(Map<String,Object> params,
 RequestOptions options)
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

correct

public CreditUnderwritingRecord correct(CreditUnderwritingRecordCorrectParams params)
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

correct

public CreditUnderwritingRecord correct(CreditUnderwritingRecordCorrectParams params,
 RequestOptions options)
                                 throws StripeException

Update a CreditUnderwritingRecord object to correct mistakes.

Throws:

StripeException

createFromApplication

public static CreditUnderwritingRecord createFromApplication(Map<String,Object> params)
                                                      throws StripeException

Creates a CreditUnderwritingRecord object with information about a credit application submission.

Throws:

StripeException

createFromApplication

public static CreditUnderwritingRecord createFromApplication(Map<String,Object> params,
 RequestOptions options)
                                                      throws StripeException

Creates a CreditUnderwritingRecord object with information about a credit application submission.

Throws:

StripeException

createFromApplication

public static CreditUnderwritingRecord createFromApplication(CreditUnderwritingRecordCreateFromApplicationParams params)
                                                      throws StripeException

Creates a CreditUnderwritingRecord object with information about a credit application submission.

Throws:

StripeException

createFromApplication

public static CreditUnderwritingRecord createFromApplication(CreditUnderwritingRecordCreateFromApplicationParams params,
 RequestOptions options)
                                                      throws StripeException

Creates a CreditUnderwritingRecord object with information about a credit application submission.

Throws:

StripeException

createFromProactiveReview

public static CreditUnderwritingRecord createFromProactiveReview(Map<String,Object> params)
                                                          throws StripeException

Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.

Throws:

StripeException

createFromProactiveReview

public static CreditUnderwritingRecord createFromProactiveReview(Map<String,Object> params,
 RequestOptions options)
                                                          throws StripeException

Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.

Throws:

StripeException

createFromProactiveReview

public static CreditUnderwritingRecord createFromProactiveReview(CreditUnderwritingRecordCreateFromProactiveReviewParams params)
                                                          throws StripeException

Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.

Throws:

StripeException

createFromProactiveReview

public static CreditUnderwritingRecord createFromProactiveReview(CreditUnderwritingRecordCreateFromProactiveReviewParams params,
 RequestOptions options)
                                                          throws StripeException

Creates a CreditUnderwritingRecord object from an underwriting decision coming from a proactive review of an existing accountholder.

Throws:

StripeException

list

public static CreditUnderwritingRecordCollection list(Map<String,Object> params)
                                               throws StripeException

Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

Throws:

StripeException

list

public static CreditUnderwritingRecordCollection list(Map<String,Object> params,
 RequestOptions options)
                                               throws StripeException

Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

Throws:

StripeException

list

public static CreditUnderwritingRecordCollection list(CreditUnderwritingRecordListParams params)
                                               throws StripeException

Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

Throws:

StripeException

list

public static CreditUnderwritingRecordCollection list(CreditUnderwritingRecordListParams params,
 RequestOptions options)
                                               throws StripeException

Retrieves a list of CreditUnderwritingRecord objects. The objects are sorted in descending order by creation date, with the most-recently-created object appearing first.

Throws:

StripeException

reportDecision

public CreditUnderwritingRecord reportDecision(Map<String,Object> params)
                                        throws StripeException

Update a CreditUnderwritingRecord object from a decision made on a credit application.

Throws:

StripeException

reportDecision

public CreditUnderwritingRecord reportDecision(Map<String,Object> params,
 RequestOptions options)
                                        throws StripeException

Update a CreditUnderwritingRecord object from a decision made on a credit application.

Throws:

StripeException

reportDecision

public CreditUnderwritingRecord reportDecision(CreditUnderwritingRecordReportDecisionParams params)
                                        throws StripeException

Update a CreditUnderwritingRecord object from a decision made on a credit application.

Throws:

StripeException

reportDecision

public CreditUnderwritingRecord reportDecision(CreditUnderwritingRecordReportDecisionParams params,
 RequestOptions options)
                                        throws StripeException

Update a CreditUnderwritingRecord object from a decision made on a credit application.

Throws:

StripeException

retrieve

public static CreditUnderwritingRecord retrieve(String creditUnderwritingRecord)
                                         throws StripeException

Retrieves a CreditUnderwritingRecord object.

Throws:

StripeException

retrieve

public static CreditUnderwritingRecord retrieve(String creditUnderwritingRecord,
 RequestOptions options)
                                         throws StripeException

Retrieves a CreditUnderwritingRecord object.

Throws:

StripeException

retrieve

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

Retrieves a CreditUnderwritingRecord object.

Throws:

StripeException

retrieve

public static CreditUnderwritingRecord retrieve(String creditUnderwritingRecord,
 CreditUnderwritingRecordRetrieveParams params,
 RequestOptions options)
                                         throws StripeException

Retrieves a CreditUnderwritingRecord object.

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.

getApplication

public CreditUnderwritingRecord.Application getApplication()

For decisions triggered by an application, details about the submission.

getCreated

public Long getCreated()

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

getCreatedFrom

public String getCreatedFrom()

The event that triggered the underwriting.

One of application, or proactive_review.

getCreditUser

public CreditUnderwritingRecord.CreditUser getCreditUser()

getDecidedAt

public Long getDecidedAt()

Date when a decision was made.

getDecision

public CreditUnderwritingRecord.Decision getDecision()

Details about the decision.

getDecisionDeadline

public Long getDecisionDeadline()

For underwriting initiated by an application, a decision must be taken 30 days after the submission.

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 issuing.credit_underwriting_record.

getRegulatoryReportingFile

public String getRegulatoryReportingFile()

File containing regulatory reporting data for the decision. Required if you are subject to this reporting requirement.

getUnderwritingException

public CreditUnderwritingRecord.UnderwritingException getUnderwritingException()

If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.

setApplication

public void setApplication(CreditUnderwritingRecord.Application application)

For decisions triggered by an application, details about the submission.

setCreated

public void setCreated(Long created)

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

setCreatedFrom

public void setCreatedFrom(String createdFrom)

The event that triggered the underwriting.

One of application, or proactive_review.

setCreditUser

public void setCreditUser(CreditUnderwritingRecord.CreditUser creditUser)

setDecidedAt

public void setDecidedAt(Long decidedAt)

Date when a decision was made.

setDecision

public void setDecision(CreditUnderwritingRecord.Decision decision)

Details about the decision.

setDecisionDeadline

public void setDecisionDeadline(Long decisionDeadline)

For underwriting initiated by an application, a decision must be taken 30 days after the submission.

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 issuing.credit_underwriting_record.

setRegulatoryReportingFile

public void setRegulatoryReportingFile(String regulatoryReportingFile)

File containing regulatory reporting data for the decision. Required if you are subject to this reporting requirement.

setUnderwritingException

public void setUnderwritingException(CreditUnderwritingRecord.UnderwritingException underwritingException)

If an exception to the usual underwriting criteria was made for this application, details about the exception must be provided. Exceptions should only be granted in rare circumstances, in consultation with Stripe Compliance.

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