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

#==, #[], #[]=, #_get_inner_class_type, 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.



574
575
576
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 574

def application
  @application
end

#created ⇒ Object (readonly)

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



576
577
578
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 576

def created
  @created
end

#created_from ⇒ Object (readonly)

The event that triggered the underwriting.



578
579
580
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 578

def created_from
  @created_from
end

#credit_user ⇒ Object (readonly)

Attribute for field credit_user



580
581
582
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 580

def credit_user
  @credit_user
end

#decided_at ⇒ Object (readonly)

Date when a decision was made.



582
583
584
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 582

def decided_at
  @decided_at
end

#decision ⇒ Object (readonly)

Details about the decision.



584
585
586
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 584

def decision
  @decision
end

#decision_deadline ⇒ Object (readonly)

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



586
587
588
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 586

def decision_deadline
  @decision_deadline
end

#id ⇒ Object (readonly)

Unique identifier for the object.



588
589
590
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 588

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.



590
591
592
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 590

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.



592
593
594
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 592

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



594
595
596
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 594

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



596
597
598
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 596

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.



598
599
600
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 598

def underwriting_exception
  @underwriting_exception
end

Class Method Details

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

Update a CreditUnderwritingRecord object to correct mistakes.



611
612
613
614
615
616
617
618
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 611

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.



621
622
623
624
625
626
627
628
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 621

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.



631
632
633
634
635
636
637
638
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 631

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 



679
680
681
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 679

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



670
671
672
673
674
675
676
677
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 670

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.



641
642
643
644
645
646
647
648
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 641

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.



661
662
663
664
665
666
667
668
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 661

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.



601
602
603
604
605
606
607
608
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 601

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.



651
652
653
654
655
656
657
658
 
# File 'lib/stripe/resources/issuing/credit_underwriting_record.rb', line 651

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