Class: Stripe::PaymentRecord

Inherits:
APIResource show all
Defined in:
lib/stripe/resources/payment_record.rb

Overview

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.

Defined Under Namespace

Classes: AmountCanceled, AmountFailed, AmountGuaranteed, AmountRequested, CustomerDetails, PaymentMethodDetails, ReportPaymentAttemptCanceledParams, ReportPaymentAttemptFailedParams, ReportPaymentAttemptGuaranteedParams, ReportPaymentAttemptParams, ReportPaymentParams, RetrieveParams, ShippingDetails

Constant Summary collapse

OBJECT_NAME = 
"payment_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 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

#amount_canceled ⇒ Object (readonly)

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



583
584
585
 
# File 'lib/stripe/resources/payment_record.rb', line 583

def amount_canceled
  @amount_canceled
end

#amount_failed ⇒ Object (readonly)

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



585
586
587
 
# File 'lib/stripe/resources/payment_record.rb', line 585

def amount_failed
  @amount_failed
end

#amount_guaranteed ⇒ Object (readonly)

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



587
588
589
 
# File 'lib/stripe/resources/payment_record.rb', line 587

def amount_guaranteed
  @amount_guaranteed
end

#amount_requested ⇒ Object (readonly)

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



589
590
591
 
# File 'lib/stripe/resources/payment_record.rb', line 589

def amount_requested
  @amount_requested
end

#created ⇒ Object (readonly)

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



591
592
593
 
# File 'lib/stripe/resources/payment_record.rb', line 591

def created
  @created
end

#customer_details ⇒ Object (readonly)

Customer information for this payment.



593
594
595
 
# File 'lib/stripe/resources/payment_record.rb', line 593

def customer_details
  @customer_details
end

#customer_presence ⇒ Object (readonly)

Indicates whether the customer was present in your checkout flow during this payment.



595
596
597
 
# File 'lib/stripe/resources/payment_record.rb', line 595

def customer_presence
  @customer_presence
end

#description ⇒ Object (readonly)

An arbitrary string attached to the object. Often useful for displaying to users.



597
598
599
 
# File 'lib/stripe/resources/payment_record.rb', line 597

def description
  @description
end

#id ⇒ Object (readonly)

Unique identifier for the object.



599
600
601
 
# File 'lib/stripe/resources/payment_record.rb', line 599

def id
  @id
end

#latest_payment_attempt_record ⇒ Object (readonly)

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



601
602
603
 
# File 'lib/stripe/resources/payment_record.rb', line 601

def latest_payment_attempt_record
  @latest_payment_attempt_record
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.



603
604
605
 
# File 'lib/stripe/resources/payment_record.rb', line 603

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.



605
606
607
 
# File 'lib/stripe/resources/payment_record.rb', line 605

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



607
608
609
 
# File 'lib/stripe/resources/payment_record.rb', line 607

def object
  @object
end

#payment_method_details ⇒ Object (readonly)

Information about the Payment Method debited for this payment.



609
610
611
 
# File 'lib/stripe/resources/payment_record.rb', line 609

def payment_method_details
  @payment_method_details
end

#payment_reference ⇒ Object (readonly)

An opaque string for manual reconciliation of this payment, for example a check number or a payment processor ID.



611
612
613
 
# File 'lib/stripe/resources/payment_record.rb', line 611

def payment_reference
  @payment_reference
end

#shipping_details ⇒ Object (readonly)

Shipping information for this payment.



613
614
615
 
# File 'lib/stripe/resources/payment_record.rb', line 613

def shipping_details
  @shipping_details
end

Class Method Details

.object_name ⇒ Object 



11
12
13
 
# File 'lib/stripe/resources/payment_record.rb', line 11

def self.object_name
  "payment_record"
end

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

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.



618
619
620
621
622
623
624
625
 
# File 'lib/stripe/resources/payment_record.rb', line 618

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

.report_payment_attempt(id, params = {}, opts = {}) ⇒ Object

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.



640
641
642
643
644
645
646
647
 
# File 'lib/stripe/resources/payment_record.rb', line 640

def self.report_payment_attempt(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_records/%<id>s/report_payment_attempt", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.report_payment_attempt_canceled(id, params = {}, opts = {}) ⇒ Object

Report that the most recent payment attempt on the specified Payment Record

was canceled.



662
663
664
665
666
667
668
669
 
# File 'lib/stripe/resources/payment_record.rb', line 662

def self.report_payment_attempt_canceled(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_records/%<id>s/report_payment_attempt_canceled", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.report_payment_attempt_failed(id, params = {}, opts = {}) ⇒ Object

Report that the most recent payment attempt on the specified Payment Record

failed or errored.



684
685
686
687
688
689
690
691
 
# File 'lib/stripe/resources/payment_record.rb', line 684

def self.report_payment_attempt_failed(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_records/%<id>s/report_payment_attempt_failed", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

.report_payment_attempt_guaranteed(id, params = {}, opts = {}) ⇒ Object

Report that the most recent payment attempt on the specified Payment Record

was guaranteed.



706
707
708
709
710
711
712
713
 
# File 'lib/stripe/resources/payment_record.rb', line 706

def self.report_payment_attempt_guaranteed(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_records/%<id>s/report_payment_attempt_guaranteed", { id: CGI.escape(id) }),
    params: params,
    opts: opts
  )
end

Instance Method Details

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

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.



629
630
631
632
633
634
635
636
 
# File 'lib/stripe/resources/payment_record.rb', line 629

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

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

Report that the most recent payment attempt on the specified Payment Record

was canceled.



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

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

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

Report that the most recent payment attempt on the specified Payment Record

failed or errored.



673
674
675
676
677
678
679
680
 
# File 'lib/stripe/resources/payment_record.rb', line 673

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

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

Report that the most recent payment attempt on the specified Payment Record

was guaranteed.



695
696
697
698
699
700
701
702
 
# File 'lib/stripe/resources/payment_record.rb', line 695

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