Class: PaypalServerSdk::Capture

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/paypal_server_sdk/models/capture.rb

Overview

A captured payment.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP, invoice_id: SKIP, custom_id: SKIP, network_transaction_reference: SKIP, seller_protection: SKIP, final_capture: false, seller_receivable_breakdown: SKIP, disbursement_mode: DisbursementMode::INSTANT, links: SKIP, processor_response: SKIP, create_time: SKIP, update_time: SKIP) ⇒ Capture

Returns a new instance of Capture.



142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 142

def initialize(status: SKIP, status_details: SKIP, id: SKIP, amount: SKIP,
               invoice_id: SKIP, custom_id: SKIP,
               network_transaction_reference: SKIP, seller_protection: SKIP,
               final_capture: false, seller_receivable_breakdown: SKIP,
               disbursement_mode: DisbursementMode::INSTANT, links: SKIP,
               processor_response: SKIP, create_time: SKIP,
               update_time: SKIP)
  @status = status unless status == SKIP
  @status_details = status_details unless status_details == SKIP
  @id = id unless id == SKIP
  @amount = amount unless amount == SKIP
  @invoice_id = invoice_id unless invoice_id == SKIP
  @custom_id = custom_id unless custom_id == SKIP
  unless network_transaction_reference == SKIP
    @network_transaction_reference =
      network_transaction_reference
  end
  @seller_protection = seller_protection unless seller_protection == SKIP
  @final_capture = final_capture unless final_capture == SKIP
  unless seller_receivable_breakdown == SKIP
    @seller_receivable_breakdown =
      seller_receivable_breakdown
  end
  @disbursement_mode = disbursement_mode unless disbursement_mode == SKIP
  @links = links unless links == SKIP
  @processor_response = processor_response unless processor_response == SKIP
  @create_time = create_time unless create_time == SKIP
  @update_time = update_time unless update_time == SKIP
end

Instance Attribute Details

#amount ⇒ Money

The currency and amount for a financial transaction, such as a balance or payment due.

Returns:



27
28
29
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 27

def amount
  @amount
end

#create_time ⇒ String

The date and time, in [Internet date and time format](tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

Returns:

  • (String) 


84
85
86
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 84

def create_time
  @create_time
end

#custom_id ⇒ String

The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.

Returns:

  • (String) 


39
40
41
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 39

def custom_id
  @custom_id
end

#disbursement_mode ⇒ DisbursementMode

The funds that are held on behalf of the merchant.

Returns:



66
67
68
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 66

def disbursement_mode
  @disbursement_mode
end

#final_capture ⇒ TrueClass | FalseClass

Indicates whether you can make additional captures against the authorized payment. Set to ‘true` if you do not intend to capture additional payments against the authorization. Set to `false` if you intend to capture additional payments against the authorization.

Returns:

  • (TrueClass | FalseClass) 


57
58
59
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 57

def final_capture
  @final_capture
end

#id ⇒ String

The PayPal-generated ID for the captured payment.

Returns:

  • (String) 


22
23
24
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 22

def id
  @id
end

#invoice_id ⇒ String

The API caller-provided external invoice number for this order. Appears in both the payer’s transaction history and the emails that the payer receives.

Returns:

  • (String) 


33
34
35
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 33

def invoice_id
  @invoice_id
end

#links ⇒ Array[LinkDescription]

An array of related [HATEOAS links](/docs/api/reference/api-responses/#hateoas-links).

Returns:



71
72
73
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 71

def links
  @links
end

#network_transaction_reference ⇒ NetworkTransactionReference

Reference values used by the card network to identify a transaction.

Returns:



43
44
45
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 43

def network_transaction_reference
  @network_transaction_reference
end

#processor_response ⇒ ProcessorResponse

The processor response information for payment requests, such as direct credit card transactions.

Returns:



76
77
78
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 76

def processor_response
  @processor_response
end

#seller_protection ⇒ SellerProtection

The level of protection offered as defined by [PayPal Seller Protection for Merchants](www.paypal.com/us/webapps/mpp/security/seller-protectio n).

Returns:



50
51
52
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 50

def seller_protection
  @seller_protection
end

#seller_receivable_breakdown ⇒ SellerReceivableBreakdown

The detailed breakdown of the capture activity. This is not available for transactions that are in pending state.

Returns:



62
63
64
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 62

def seller_receivable_breakdown
  @seller_receivable_breakdown
end

#status ⇒ CaptureStatus

The status of the captured payment.

Returns:



14
15
16
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 14

def status
  @status
end

#status_details ⇒ CaptureStatusDetails

The details of the captured payment status.

Returns:



18
19
20
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 18

def status_details
  @status_details
end

#update_time ⇒ String

The date and time, in [Internet date and time format](tools.ietf.org/html/rfc3339#section-5.6). Seconds are required while fractional seconds are optional.<blockquote><strong>Note:</strong> The regular expression provides guidance but does not reject all invalid dates.</blockquote>

Returns:

  • (String) 


92
93
94
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 92

def update_time
  @update_time
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 173

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  status = hash.key?('status') ? hash['status'] : SKIP
  status_details = CaptureStatusDetails.from_hash(hash['status_details']) if
    hash['status_details']
  id = hash.key?('id') ? hash['id'] : SKIP
  amount = Money.from_hash(hash['amount']) if hash['amount']
  invoice_id = hash.key?('invoice_id') ? hash['invoice_id'] : SKIP
  custom_id = hash.key?('custom_id') ? hash['custom_id'] : SKIP
  if hash['network_transaction_reference']
    network_transaction_reference = NetworkTransactionReference.from_hash(hash['network_transaction_reference'])
  end
  seller_protection = SellerProtection.from_hash(hash['seller_protection']) if
    hash['seller_protection']
  final_capture = hash['final_capture'] ||= false
  if hash['seller_receivable_breakdown']
    seller_receivable_breakdown = SellerReceivableBreakdown.from_hash(hash['seller_receivable_breakdown'])
  end
  disbursement_mode =
    hash['disbursement_mode'] ||= DisbursementMode::INSTANT
  # Parameter is an array, so we need to iterate through it
  links = nil
  unless hash['links'].nil?
    links = []
    hash['links'].each do |structure|
      links << (LinkDescription.from_hash(structure) if structure)
    end
  end

  links = SKIP unless hash.key?('links')
  processor_response = ProcessorResponse.from_hash(hash['processor_response']) if
    hash['processor_response']
  create_time = hash.key?('create_time') ? hash['create_time'] : SKIP
  update_time = hash.key?('update_time') ? hash['update_time'] : SKIP

  # Create object from extracted values.
  Capture.new(status: status,
              status_details: status_details,
              id: id,
              amount: amount,
              invoice_id: invoice_id,
              custom_id: custom_id,
              network_transaction_reference: network_transaction_reference,
              seller_protection: seller_protection,
              final_capture: final_capture,
              seller_receivable_breakdown: seller_receivable_breakdown,
              disbursement_mode: disbursement_mode,
              links: links,
              processor_response: processor_response,
              create_time: create_time,
              update_time: update_time)
end

.names ⇒ Object

A mapping from model property names to API property names.



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 95

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['status'] = 'status'
  @_hash['status_details'] = 'status_details'
  @_hash['id'] = 'id'
  @_hash['amount'] = 'amount'
  @_hash['invoice_id'] = 'invoice_id'
  @_hash['custom_id'] = 'custom_id'
  @_hash['network_transaction_reference'] =
    'network_transaction_reference'
  @_hash['seller_protection'] = 'seller_protection'
  @_hash['final_capture'] = 'final_capture'
  @_hash['seller_receivable_breakdown'] = 'seller_receivable_breakdown'
  @_hash['disbursement_mode'] = 'disbursement_mode'
  @_hash['links'] = 'links'
  @_hash['processor_response'] = 'processor_response'
  @_hash['create_time'] = 'create_time'
  @_hash['update_time'] = 'update_time'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



138
139
140
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 138

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/paypal_server_sdk/models/capture.rb', line 117

def self.optionals
  %w[
    status
    status_details
    id
    amount
    invoice_id
    custom_id
    network_transaction_reference
    seller_protection
    final_capture
    seller_receivable_breakdown
    disbursement_mode
    links
    processor_response
    create_time
    update_time
  ]
end