Class: Stripe::PaymentRecord::ReportPaymentParams

Inherits:

RequestParams

• Object
• RequestParams
• Stripe::PaymentRecord::ReportPaymentParams

Defined in:

lib/stripe/resources/payment_record.rb

Defined Under Namespace

Classes: AmountRequested, CustomerDetails, Failed, Guaranteed, PaymentMethodDetails, ShippingDetails

Instance Attribute Summary

• #amount_requested ⇒ Object

  The amount you intend to collect for this payment.

• #customer_details ⇒ Object

  Customer information for this payment.

• #customer_presence ⇒ Object

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

• #description ⇒ Object

  An arbitrary string attached to the object.

• #expand ⇒ Object

  Specifies which fields in the response should be expanded.

• #failed ⇒ Object

  Information about the payment attempt failure.

• #guaranteed ⇒ Object

  Information about the payment attempt guarantee.

• #initiated_at ⇒ Object

  When the reported payment was initiated.

• #metadata ⇒ Object

  Set of [key-value pairs](stripe.com/docs/api/metadata) that you can attach to an object.

• #outcome ⇒ Object

  The outcome of the reported payment.

• #payment_method_details ⇒ Object

  Information about the Payment Method debited for this payment.

• #payment_reference ⇒ Object

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

• #shipping_details ⇒ Object

  Shipping information for this payment.

Instance Method Summary

• #initialize(amount_requested: nil, customer_details: nil, customer_presence: nil, description: nil, expand: nil, failed: nil, guaranteed: nil, initiated_at: nil, metadata: nil, outcome: nil, payment_method_details: nil, payment_reference: nil, shipping_details: nil) ⇒ ReportPaymentParams constructor

  A new instance of ReportPaymentParams.

Methods inherited from RequestParams

#to_h

Constructor Details

#initialize(amount_requested: nil, customer_details: nil, customer_presence: nil, description: nil, expand: nil, failed: nil, guaranteed: nil, initiated_at: nil, metadata: nil, outcome: nil, payment_method_details: nil, payment_reference: nil, shipping_details: nil) ⇒ ReportPaymentParams

Returns a new instance of ReportPaymentParams.

# File 'lib/stripe/resources/payment_record.rb', line 1444

def initialize(
  amount_requested: nil,
  customer_details: nil,
  customer_presence: nil,
  description: nil,
  expand: nil,
  failed: nil,
  guaranteed: nil,
  initiated_at: nil,
  metadata: nil,
  outcome: nil,
  payment_method_details: nil,
  payment_reference: nil,
  shipping_details: nil
)
  @amount_requested = amount_requested
  @customer_details = customer_details
  @customer_presence = customer_presence
  @description = description
  @expand = expand
  @failed = failed
  @guaranteed = guaranteed
  @initiated_at = initiated_at
  @metadata = metadata
  @outcome = outcome
  @payment_method_details = payment_method_details
  @payment_reference = payment_reference
  @shipping_details = shipping_details
end

Instance Attribute Details

#amount_requested ⇒ Object

The amount you intend to collect for this payment.

# File 'lib/stripe/resources/payment_record.rb', line 1418

def amount_requested
  @amount_requested
end

#customer_details ⇒ Object

Customer information for this payment.

# File 'lib/stripe/resources/payment_record.rb', line 1420

def customer_details
  @customer_details
end

#customer_presence ⇒ Object

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

# File 'lib/stripe/resources/payment_record.rb', line 1422

def customer_presence
  @customer_presence
end

#description ⇒ Object

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

# File 'lib/stripe/resources/payment_record.rb', line 1424

def description
  @description
end

#expand ⇒ Object

Specifies which fields in the response should be expanded.

# File 'lib/stripe/resources/payment_record.rb', line 1426

def expand
  @expand
end

#failed ⇒ Object

Information about the payment attempt failure.

# File 'lib/stripe/resources/payment_record.rb', line 1428

def failed
  @failed
end

#guaranteed ⇒ Object

Information about the payment attempt guarantee.

# File 'lib/stripe/resources/payment_record.rb', line 1430

def guaranteed
  @guaranteed
end

#initiated_at ⇒ Object

When the reported payment was initiated. Measured in seconds since the Unix epoch.

# File 'lib/stripe/resources/payment_record.rb', line 1432

def initiated_at
  @initiated_at
end

#metadata ⇒ Object

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. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to ‘metadata`.

# File 'lib/stripe/resources/payment_record.rb', line 1434

def metadata
  @metadata
end

#outcome ⇒ Object

The outcome of the reported payment.

# File 'lib/stripe/resources/payment_record.rb', line 1436

def outcome
  @outcome
end

#payment_method_details ⇒ Object

Information about the Payment Method debited for this payment.

# File 'lib/stripe/resources/payment_record.rb', line 1438

def payment_method_details
  @payment_method_details
end

#payment_reference ⇒ Object

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

# File 'lib/stripe/resources/payment_record.rb', line 1440

def payment_reference
  @payment_reference
end

#shipping_details ⇒ Object

Shipping information for this payment.

# File 'lib/stripe/resources/payment_record.rb', line 1442

def shipping_details
  @shipping_details
end