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: Amount, AmountAuthorized, AmountCanceled, AmountFailed, AmountGuaranteed, AmountRefunded, AmountRequested, CustomerDetails, PaymentMethodDetails, ProcessorDetails, 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

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

#amount ⇒ Object (readonly)

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



2033
2034
2035
 
# File 'lib/stripe/resources/payment_record.rb', line 2033

def amount
  @amount
end

#amount_authorized ⇒ Object (readonly)

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



2035
2036
2037
 
# File 'lib/stripe/resources/payment_record.rb', line 2035

def amount_authorized
  @amount_authorized
end

#amount_canceled ⇒ Object (readonly)

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



2037
2038
2039
 
# File 'lib/stripe/resources/payment_record.rb', line 2037

def amount_canceled
  @amount_canceled
end

#amount_failed ⇒ Object (readonly)

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



2039
2040
2041
 
# File 'lib/stripe/resources/payment_record.rb', line 2039

def amount_failed
  @amount_failed
end

#amount_guaranteed ⇒ Object (readonly)

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



2041
2042
2043
 
# File 'lib/stripe/resources/payment_record.rb', line 2041

def amount_guaranteed
  @amount_guaranteed
end

#amount_refunded ⇒ Object (readonly)

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



2043
2044
2045
 
# File 'lib/stripe/resources/payment_record.rb', line 2043

def amount_refunded
  @amount_refunded
end

#amount_requested ⇒ Object (readonly)

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



2045
2046
2047
 
# File 'lib/stripe/resources/payment_record.rb', line 2045

def amount_requested
  @amount_requested
end

#application ⇒ Object (readonly)

ID of the Connect application that created the PaymentRecord.



2047
2048
2049
 
# File 'lib/stripe/resources/payment_record.rb', line 2047

def application
  @application
end

#created ⇒ Object (readonly)

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



2049
2050
2051
 
# File 'lib/stripe/resources/payment_record.rb', line 2049

def created
  @created
end

#customer_details ⇒ Object (readonly)

Customer information for this payment.



2051
2052
2053
 
# File 'lib/stripe/resources/payment_record.rb', line 2051

def customer_details
  @customer_details
end

#customer_presence ⇒ Object (readonly)

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



2053
2054
2055
 
# File 'lib/stripe/resources/payment_record.rb', line 2053

def customer_presence
  @customer_presence
end

#description ⇒ Object (readonly)

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



2055
2056
2057
 
# File 'lib/stripe/resources/payment_record.rb', line 2055

def description
  @description
end

#id ⇒ Object (readonly)

Unique identifier for the object.



2057
2058
2059
 
# File 'lib/stripe/resources/payment_record.rb', line 2057

def id
  @id
end

#latest_payment_attempt_record ⇒ Object (readonly)

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



2059
2060
2061
 
# File 'lib/stripe/resources/payment_record.rb', line 2059

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.



2061
2062
2063
 
# File 'lib/stripe/resources/payment_record.rb', line 2061

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.



2063
2064
2065
 
# File 'lib/stripe/resources/payment_record.rb', line 2063

def metadata
  @metadata
end

#object ⇒ Object (readonly)

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



2065
2066
2067
 
# File 'lib/stripe/resources/payment_record.rb', line 2065

def object
  @object
end

#payment_method_details ⇒ Object (readonly)

Information about the Payment Method debited for this payment.



2067
2068
2069
 
# File 'lib/stripe/resources/payment_record.rb', line 2067

def payment_method_details
  @payment_method_details
end

#processor_details ⇒ Object (readonly)

Processor information associated with this payment.



2069
2070
2071
 
# File 'lib/stripe/resources/payment_record.rb', line 2069

def processor_details
  @processor_details
end

#shipping_details ⇒ Object (readonly)

Shipping information for this payment.



2071
2072
2073
 
# File 'lib/stripe/resources/payment_record.rb', line 2071

def shipping_details
  @shipping_details
end

Class Method Details

.field_remappings ⇒ Object 



2231
2232
2233
 
# File 'lib/stripe/resources/payment_record.rb', line 2231

def self.field_remappings
  @field_remappings = {}
end

.inner_class_types ⇒ Object 



2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
 
# File 'lib/stripe/resources/payment_record.rb', line 2215

def self.inner_class_types
  @inner_class_types = {
    amount: Amount,
    amount_authorized: AmountAuthorized,
    amount_canceled: AmountCanceled,
    amount_failed: AmountFailed,
    amount_guaranteed: AmountGuaranteed,
    amount_refunded: AmountRefunded,
    amount_requested: AmountRequested,
    customer_details: CustomerDetails,
    payment_method_details: PaymentMethodDetails,
    processor_details: ProcessorDetails,
    shipping_details: ShippingDetails,
  }
end

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



2076
2077
2078
2079
2080
2081
2082
2083
 
# File 'lib/stripe/resources/payment_record.rb', line 2076

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.



2098
2099
2100
2101
2102
2103
2104
2105
 
# File 'lib/stripe/resources/payment_record.rb', line 2098

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.



2120
2121
2122
2123
2124
2125
2126
2127
 
# File 'lib/stripe/resources/payment_record.rb', line 2120

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.



2142
2143
2144
2145
2146
2147
2148
2149
 
# File 'lib/stripe/resources/payment_record.rb', line 2142

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.



2164
2165
2166
2167
2168
2169
2170
2171
 
# File 'lib/stripe/resources/payment_record.rb', line 2164

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

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

Report informational updates on the specified Payment Record.



2184
2185
2186
2187
2188
2189
2190
2191
 
# File 'lib/stripe/resources/payment_record.rb', line 2184

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

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

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

was refunded.



2206
2207
2208
2209
2210
2211
2212
2213
 
# File 'lib/stripe/resources/payment_record.rb', line 2206

def self.report_refund(id, params = {}, opts = {})
  request_stripe_object(
    method: :post,
    path: format("/v1/payment_records/%<id>s/report_refund", { 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.



2087
2088
2089
2090
2091
2092
2093
2094
 
# File 'lib/stripe/resources/payment_record.rb', line 2087

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.



2109
2110
2111
2112
2113
2114
2115
2116
 
# File 'lib/stripe/resources/payment_record.rb', line 2109

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.



2131
2132
2133
2134
2135
2136
2137
2138
 
# File 'lib/stripe/resources/payment_record.rb', line 2131

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.



2153
2154
2155
2156
2157
2158
2159
2160
 
# File 'lib/stripe/resources/payment_record.rb', line 2153

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

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

Report informational updates on the specified Payment Record.



2174
2175
2176
2177
2178
2179
2180
2181
 
# File 'lib/stripe/resources/payment_record.rb', line 2174

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

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

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

was refunded.



2195
2196
2197
2198
2199
2200
2201
2202
 
# File 'lib/stripe/resources/payment_record.rb', line 2195

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