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](stripe.com/docs/issuing/credit/report-credit-decisions-and-manage-aans) to learn about your requirements as a platform.

Defined Under Namespace

Classes: Application, CorrectParams, CreateFromApplicationParams, CreateFromProactiveReviewParams, CreditUser, Decision, ListParams, ReportDecisionParams, 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

#==, #[], #[]=, additive_object_param, additive_object_param?, #as_json, construct_from, #deleted?, #dirty!, #each, #eql?, #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.



505
506
507
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 505

def application
  @application
end

#created ⇒ Object (readonly)

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



507
508
509
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 507

def created
  @created
end

#created_from ⇒ Object (readonly)

The event that triggered the underwriting.



509
510
511
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 509

def created_from
  @created_from
end

#credit_user ⇒ Object (readonly)

Attribute for field credit_user



511
512
513
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 511

def credit_user
  @credit_user
end

#decided_at ⇒ Object (readonly)

Date when a decision was made.



513
514
515
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 513

def decided_at
  @decided_at
end

#decision ⇒ Object (readonly)

Details about the decision.



515
516
517
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 515

def decision
  @decision
end

#decision_deadline ⇒ Object (readonly)

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



517
518
519
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 517

def decision_deadline
  @decision_deadline
end

#id ⇒ Object (readonly)

Unique identifier for the object.



519
520
521
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 519

def id
  @id
end

#livemode ⇒ Object (readonly)

Has the value ‘true` if the object exists in live mode or the value `false` if the object exists in test mode.



521
522
523
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 521

def livemode
  @livemode
end

#metadata ⇒ Object (readonly)

Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.



523
524
525
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 523

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



525
526
527
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 525

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](stripe.com/docs/issuing/credit/report-required-regulatory-data-for-credit-decisions).



527
528
529
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 527

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.



529
530
531
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 529

def underwriting_exception
  @underwriting_exception
end

Class Method Details

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

Update a CreditUnderwritingRecord object to correct mistakes.



542
543
544
545
546
547
548
549
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 542

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.



552
553
554
555
556
557
558
559
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 552

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.



562
563
564
565
566
567
568
569
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 562

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

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



572
573
574
575
576
577
578
579
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 572

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.



592
593
594
595
596
597
598
599
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 592

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

Instance Method Details

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

Update a CreditUnderwritingRecord object to correct mistakes.



532
533
534
535
536
537
538
539
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 532

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.



582
583
584
585
586
587
588
589
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 582

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