Class: Stripe::Issuing::CreditUnderwritingRecord

Inherits:
APIResource show all
Extended by:
APIOperations::List
Defined in:
lib/stripe/resources/issuing/credit_underwriting_record.rb

Overview

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.

Defined Under Namespace

Classes: Application, CreditUser, Decision, UnderwritingException

Constant Summary collapse

OBJECT_NAME = 
"issuing.credit_underwriting_record"

Constants inherited from StripeObject

StripeObject::RESERVED_FIELD_NAMES

Instance Attribute Summary collapse

Attributes inherited from APIResource

#save_with_parent

Attributes inherited from StripeObject

#last_response

Class Method Summary collapse

Instance Method Summary collapse

Methods included from APIOperations::List

list

Methods inherited from APIResource

class_name, custom_method, #refresh, #request_stripe_object, resource_url, #resource_url, retrieve, save_nested_resource

Methods included from APIOperations::Request

included

Methods inherited from StripeObject

#==, #[], #[]=, #_get_inner_class_type, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, field_encodings, #hash, #initialize, #inspect, #keys, #marshal_dump, #marshal_load, protected_fields, #serialize_params, #to_hash, #to_json, #to_s, #update_attributes, #values

Constructor Details

This class inherits a constructor from Stripe::StripeObject

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Stripe::StripeObject

Instance Attribute Details

#application ⇒ Object (readonly)

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



153
154
155
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 153

def application
  @application
end

#created ⇒ Object (readonly)

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



155
156
157
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 155

def created
  @created
end

#created_from ⇒ Object (readonly)

The event that triggered the underwriting.



157
158
159
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 157

def created_from
  @created_from
end

#credit_user ⇒ Object (readonly)

Attribute for field credit_user



159
160
161
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 159

def credit_user
  @credit_user
end

#decided_at ⇒ Object (readonly)

Date when a decision was made.



161
162
163
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 161

def decided_at
  @decided_at
end

#decision ⇒ Object (readonly)

Details about the decision.



163
164
165
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 163

def decision
  @decision
end

#decision_deadline ⇒ Object (readonly)

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



165
166
167
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 165

def decision_deadline
  @decision_deadline
end

#decision_deadline_updated_at ⇒ Object (readonly)

Time at which the decision deadline was last updated.



167
168
169
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 167

def decision_deadline_updated_at
  @decision_deadline_updated_at
end

#id ⇒ Object (readonly)

Unique identifier for the object.



169
170
171
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 169

def id
  @id
end

#livemode ⇒ Object (readonly)

If the object exists in live mode, the value is true. If the object exists in test mode, the value is false.



171
172
173
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 171

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

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.



173
174
175
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 173

def metadata
  @metadata
end

#object ⇒ Object (readonly)

String representing the object's type. Objects of the same type share the same value.



175
176
177
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 175

def object
  @object
end

#regulatory_reporting_file ⇒ Object (readonly)

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



177
178
179
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 177

def regulatory_reporting_file
  @regulatory_reporting_file
end

#underwriting_exception ⇒ Object (readonly)

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.



179
180
181
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 179

def underwriting_exception
  @underwriting_exception
end

Class Method Details

.correct(credit_underwriting_record, params = {}, opts = {}) ⇒ Object

Update a CreditUnderwritingRecord object to correct mistakes.



192
193
194
195
196
197
198
199
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 192

def self.correct(credit_underwriting_record, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
    params: params,
    opts: opts
  )
end

.create_from_application(params = {}, opts = {}) ⇒ Object

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



202
203
204
205
206
207
208
209
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 202

def self.create_from_application(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/issuing/credit_underwriting_records/create_from_application",
    params: params,
    opts: opts
  )
end

.create_from_proactive_review(params = {}, opts = {}) ⇒ Object

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



212
213
214
215
216
217
218
219
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 212

def self.create_from_proactive_review(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: "/v1/issuing/credit_underwriting_records/create_from_proactive_review",
    params: params,
    opts: opts
  )
end

.field_remappings ⇒ Object 



280
281
282
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 280

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



271
272
273
274
275
276
277
278
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 271

def self.inner_class_types
  @inner_class_types = {
    application: Application,
    credit_user: CreditUser,
    decision: Decision,
    underwriting_exception: UnderwritingException,
  }
end

.list(params = {}, opts = {}) ⇒ Object

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



222
223
224
225
226
227
228
229
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 222

def self.list(params = {}, opts = {})
  request_stripe_object(
    method: :get,
    path: "/v1/issuing/credit_underwriting_records",
    params: params,
    opts: opts
  )
end

.object_name ⇒ Object 



13
14
15
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 13

def self.object_name
  "issuing.credit_underwriting_record"
end

.report_decision(credit_underwriting_record, params = {}, opts = {}) ⇒ Object

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



242
243
244
245
246
247
248
249
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 242

def self.report_decision(credit_underwriting_record, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
    params: params,
    opts: opts
  )
end

.report_offer_acceptance(credit_underwriting_record, params = {}, opts = {}) ⇒ Object

Update a CreditUnderwritingRecord object to report that a credit offer has been accepted.



262
263
264
265
266
267
268
269
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 262

def self.report_offer_acceptance(credit_underwriting_record, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_offer_acceptance", { credit_underwriting_record: CGI.escape(credit_underwriting_record) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

#correct(params = {}, opts = {}) ⇒ Object

Update a CreditUnderwritingRecord object to correct mistakes.



182
183
184
185
186
187
188
189
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 182

def correct(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/correct", { credit_underwriting_record: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#report_decision(params = {}, opts = {}) ⇒ Object

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



232
233
234
235
236
237
238
239
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 232

def report_decision(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_decision", { credit_underwriting_record: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end

#report_offer_acceptance(params = {}, opts = {}) ⇒ Object

Update a CreditUnderwritingRecord object to report that a credit offer has been accepted.



252
253
254
255
256
257
258
259
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 252

def report_offer_acceptance(params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/issuing/credit_underwriting_records/%<credit_underwriting_record>s/report_offer_acceptance", { credit_underwriting_record: CGI.escape(self["id"]) }),
    params: params,
    opts: opts
  )
end