Class: SquareConnect::TransactionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/square_connect/api/transactions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionsApi

Returns a new instance of TransactionsApi.



16
17
18
 
# File 'lib/square_connect/api/transactions_api.rb', line 16

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/square_connect/api/transactions_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#capture_transaction(location_id, transaction_id, opts = {}) ⇒ CaptureTransactionResponse

CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a ‘delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Parameters:

  • location_id
  • transaction_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/square_connect/api/transactions_api.rb', line 26

def capture_transaction(location_id, transaction_id, opts = {})
  data, _status_code, _headers = capture_transaction_with_http_info(location_id, transaction_id, opts)
  return data
end

#capture_transaction_with_http_info(location_id, transaction_id, opts = {}) ⇒ Array<(CaptureTransactionResponse, Fixnum, Hash)>

CaptureTransaction Captures a transaction that was created with the [Charge](#endpoint-charge) endpoint with a &#x60;delay_capture&#x60; value of &#x60;true&#x60;. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Parameters:

  • location_id
  • transaction_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CaptureTransactionResponse, Fixnum, Hash)>) —

    CaptureTransactionResponse data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/square_connect/api/transactions_api.rb', line 37

def capture_transaction_with_http_info(location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.capture_transaction ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.capture_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionsApi.capture_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions/{transaction_id}/capture".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s).sub('{' + 'transaction_id' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CaptureTransactionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#capture_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#charge(location_id, body, opts = {}) ⇒ ChargeResponse

Charge Charges a card represented by a card nonce or a customer’s card on file. Your request to this endpoint must include either: - A value for the ‘card_nonce` parameter (to charge a card nonce generated with the `SqPaymentForm`) - Values for the `customer_card_id` and `customer_id` parameters (to charge a customer’s card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](squareup.com/help/article/5394), you must provide values for the following parameters in your request: - ‘buyer_email_address` - At least one of `billing_address` or `shipping_address` When this response is returned, the amount of Square’s processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the ‘processing_fee_money` field of each [Tender included](#type-tender) in the transaction.

Parameters:

  • location_id —

    The ID of the location to associate the created transaction with.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/square_connect/api/transactions_api.rb', line 83

def charge(location_id, body, opts = {})
  data, _status_code, _headers = charge_with_http_info(location_id, body, opts)
  return data
end

#charge_with_http_info(location_id, body, opts = {}) ⇒ Array<(ChargeResponse, Fixnum, Hash)>

Charge Charges a card represented by a card nonce or a customer&#39;s card on file. Your request to this endpoint must include either: - A value for the &#x60;card_nonce&#x60; parameter (to charge a card nonce generated with the &#x60;SqPaymentForm&#x60;) - Values for the &#x60;customer_card_id&#x60; and &#x60;customer_id&#x60; parameters (to charge a customer&#39;s card on file) In order for an eCommerce payment to potentially qualify for [Square chargeback protection](squareup.com/help/article/5394), you must provide values for the following parameters in your request: - &#x60;buyer_email_address&#x60; - At least one of &#x60;billing_address&#x60; or &#x60;shipping_address&#x60; When this response is returned, the amount of Square&#39;s processing fee might not yet be calculated. To obtain the processing fee, wait about ten seconds and call [RetrieveTransaction](#endpoint-retrievetransaction). See the &#x60;processing_fee_money&#x60; field of each [Tender included](#type-tender) in the transaction.

Parameters:

  • location_id —

    The ID of the location to associate the created transaction with.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ChargeResponse, Fixnum, Hash)>) —

    ChargeResponse data, response status code and response headers



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/square_connect/api/transactions_api.rb', line 94

def charge_with_http_info(location_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.charge ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.charge" if location_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TransactionsApi.charge" if body.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ChargeResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_refund(location_id, transaction_id, body, opts = {}) ⇒ CreateRefundResponse

CreateRefund Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](squareup.com/help/us/en/article/5060) for more information on refund behavior.

Parameters:

  • location_id —

    The ID of the original transaction&#39;s associated location.

  • transaction_id —

    The ID of the original transaction that includes the tender to refund.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



141
142
143
144
 
# File 'lib/square_connect/api/transactions_api.rb', line 141

def create_refund(location_id, transaction_id, body, opts = {})
  data, _status_code, _headers = create_refund_with_http_info(location_id, transaction_id, body, opts)
  return data
end

#create_refund_with_http_info(location_id, transaction_id, body, opts = {}) ⇒ Array<(CreateRefundResponse, Fixnum, Hash)>

CreateRefund Initiates a refund for a previously charged tender. You must issue a refund within 120 days of the associated payment. See [this article](squareup.com/help/us/en/article/5060) for more information on refund behavior.

Parameters:

  • location_id —

    The ID of the original transaction&#39;s associated location.

  • transaction_id —

    The ID of the original transaction that includes the tender to refund.

  • body —

    An object containing the fields to POST for the request. See the corresponding object definition for field details.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CreateRefundResponse, Fixnum, Hash)>) —

    CreateRefundResponse data, response status code and response headers



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/square_connect/api/transactions_api.rb', line 153

def create_refund_with_http_info(location_id, transaction_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.create_refund ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.create_refund" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionsApi.create_refund" if transaction_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TransactionsApi.create_refund" if body.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions/{transaction_id}/refund".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s).sub('{' + 'transaction_id' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'CreateRefundResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#create_refund\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_refunds(location_id, opts = {}) ⇒ ListRefundsResponse

ListRefunds Lists refunds for one of a business’s locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square’s Point of Sale applications. Refunds with a ‘status` of `PENDING` are not currently included in this endpoint’s response. Max results per [page](#paginatingresults): 50

Parameters:

  • location_id —

    The ID of the location to list refunds for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :begin_time (String) —

    The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

  • :end_time (String) —

    The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.

  • :sort_order (String) —

    The order in which results are listed in the response (&#x60;ASC&#x60; for oldest first, &#x60;DESC&#x60; for newest first). Default value: &#x60;DESC&#x60;

  • :cursor (String) —

    A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.

Returns:



204
205
206
207
 
# File 'lib/square_connect/api/transactions_api.rb', line 204

def list_refunds(location_id, opts = {})
  data, _status_code, _headers = list_refunds_with_http_info(location_id, opts)
  return data
end

#list_refunds_with_http_info(location_id, opts = {}) ⇒ Array<(ListRefundsResponse, Fixnum, Hash)>

ListRefunds Lists refunds for one of a business&#39;s locations. In addition to full or partial tender refunds processed through Square APIs, refunds may result from itemized returns or exchanges through Square&#39;s Point of Sale applications. Refunds with a &#x60;status&#x60; of &#x60;PENDING&#x60; are not currently included in this endpoint&#39;s response. Max results per [page](#paginatingresults): 50

Parameters:

  • location_id —

    The ID of the location to list refunds for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :begin_time (String) —

    The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

  • :end_time (String) —

    The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.

  • :sort_order (String) —

    The order in which results are listed in the response (&#x60;ASC&#x60; for oldest first, &#x60;DESC&#x60; for newest first). Default value: &#x60;DESC&#x60;

  • :cursor (String) —

    A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.

Returns:

  • (Array<(ListRefundsResponse, Fixnum, Hash)>) —

    ListRefundsResponse data, response status code and response headers



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/square_connect/api/transactions_api.rb', line 218

def list_refunds_with_http_info(location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.list_refunds ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.list_refunds" if location_id.nil?
  if opts[:'sort_order'] && !['DESC', 'ASC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of DESC, ASC'
  end
  # resource path
  local_var_path = "/v2/locations/{location_id}/refunds".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'begin_time'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
  query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListRefundsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#list_refunds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_transactions(location_id, opts = {}) ⇒ ListTransactionsResponse

ListTransactions Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50

Parameters:

  • location_id —

    The ID of the location to list transactions for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :begin_time (String) —

    The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

  • :end_time (String) —

    The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.

  • :sort_order (String) —

    The order in which results are listed in the response (&#x60;ASC&#x60; for oldest first, &#x60;DESC&#x60; for newest first). Default value: &#x60;DESC&#x60;

  • :cursor (String) —

    A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.

Returns:



272
273
274
275
 
# File 'lib/square_connect/api/transactions_api.rb', line 272

def list_transactions(location_id, opts = {})
  data, _status_code, _headers = list_transactions_with_http_info(location_id, opts)
  return data
end

#list_transactions_with_http_info(location_id, opts = {}) ⇒ Array<(ListTransactionsResponse, Fixnum, Hash)>

ListTransactions Lists transactions for a particular location. Transactions include payment information from sales and exchanges and refund information from returns and exchanges. Max results per [page](#paginatingresults): 50

Parameters:

  • location_id —

    The ID of the location to list transactions for.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :begin_time (String) —

    The beginning of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time minus one year.

  • :end_time (String) —

    The end of the requested reporting period, in RFC 3339 format. See [Date ranges](#dateranges) for details on date inclusivity/exclusivity. Default value: The current time.

  • :sort_order (String) —

    The order in which results are listed in the response (&#x60;ASC&#x60; for oldest first, &#x60;DESC&#x60; for newest first). Default value: &#x60;DESC&#x60;

  • :cursor (String) —

    A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query. See [Paginating results](#paginatingresults) for more information.

Returns:

  • (Array<(ListTransactionsResponse, Fixnum, Hash)>) —

    ListTransactionsResponse data, response status code and response headers



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/square_connect/api/transactions_api.rb', line 286

def list_transactions_with_http_info(location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.list_transactions ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.list_transactions" if location_id.nil?
  if opts[:'sort_order'] && !['DESC', 'ASC'].include?(opts[:'sort_order'])
    fail ArgumentError, 'invalid value for "sort_order", must be one of DESC, ASC'
  end
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'begin_time'] = opts[:'begin_time'] if !opts[:'begin_time'].nil?
  query_params[:'end_time'] = opts[:'end_time'] if !opts[:'end_time'].nil?
  query_params[:'sort_order'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ListTransactionsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#retrieve_transaction(location_id, transaction_id, opts = {}) ⇒ RetrieveTransactionResponse

RetrieveTransaction Retrieves details for a single transaction.

Parameters:

  • location_id —

    The ID of the transaction&#39;s associated location.

  • transaction_id —

    The ID of the transaction to retrieve.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



337
338
339
340
 
# File 'lib/square_connect/api/transactions_api.rb', line 337

def retrieve_transaction(location_id, transaction_id, opts = {})
  data, _status_code, _headers = retrieve_transaction_with_http_info(location_id, transaction_id, opts)
  return data
end

#retrieve_transaction_with_http_info(location_id, transaction_id, opts = {}) ⇒ Array<(RetrieveTransactionResponse, Fixnum, Hash)>

RetrieveTransaction Retrieves details for a single transaction.

Parameters:

  • location_id —

    The ID of the transaction&#39;s associated location.

  • transaction_id —

    The ID of the transaction to retrieve.

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/square_connect/api/transactions_api.rb', line 348

def retrieve_transaction_with_http_info(location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.retrieve_transaction ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.retrieve_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionsApi.retrieve_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions/{transaction_id}".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s).sub('{' + 'transaction_id' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'RetrieveTransactionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#retrieve_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_transaction(location_id, transaction_id, opts = {}) ⇒ VoidTransactionResponse

VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a ‘delay_capture` value of `true`. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Parameters:

  • location_id
  • transaction_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



394
395
396
397
 
# File 'lib/square_connect/api/transactions_api.rb', line 394

def void_transaction(location_id, transaction_id, opts = {})
  data, _status_code, _headers = void_transaction_with_http_info(location_id, transaction_id, opts)
  return data
end

#void_transaction_with_http_info(location_id, transaction_id, opts = {}) ⇒ Array<(VoidTransactionResponse, Fixnum, Hash)>

VoidTransaction Cancels a transaction that was created with the [Charge](#endpoint-charge) endpoint with a &#x60;delay_capture&#x60; value of &#x60;true&#x60;. See [Delayed capture transactions](/articles/delayed-capture-transactions/) for more information.

Parameters:

  • location_id
  • transaction_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(VoidTransactionResponse, Fixnum, Hash)>) —

    VoidTransactionResponse data, response status code and response headers



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/square_connect/api/transactions_api.rb', line 405

def void_transaction_with_http_info(location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionsApi.void_transaction ..."
  end
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionsApi.void_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionsApi.void_transaction" if transaction_id.nil?
  # resource path
  local_var_path = "/v2/locations/{location_id}/transactions/{transaction_id}/void".sub('{format}','json').sub('{' + 'location_id' + '}', location_id.to_s).sub('{' + 'transaction_id' + '}', transaction_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['oauth2']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'VoidTransactionResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransactionsApi#void_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end