Class: SquareConnect::TransactionApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransactionApi

Returns a new instance of TransactionApi.



16
17
18
 
# File 'lib/square_connect/api/transaction_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/transaction_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#capture_transaction(authorization, 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format `Bearer YOUR_ACCESS_TOKEN_HERE`.

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/square_connect/api/transaction_api.rb', line 27

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

#capture_transaction_with_http_info(authorization, 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

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

    the optional parameters

Returns:

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

    CaptureTransactionResponse data, response status code and response headers



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
76
77
78
79
80
 
# File 'lib/square_connect/api/transaction_api.rb', line 39

def capture_transaction_with_http_info(authorization, location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionApi.capture_transaction ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling TransactionApi.capture_transaction" if authorization.nil?
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionApi.capture_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionApi.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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: TransactionApi#capture_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#charge(authorization, 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 e-commerce 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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:



89
90
91
92
 
# File 'lib/square_connect/api/transaction_api.rb', line 89

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

#charge_with_http_info(authorization, 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 e-commerce 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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



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
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/square_connect/api/transaction_api.rb', line 101

def charge_with_http_info(authorization, location_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionApi.charge ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling TransactionApi.charge" if authorization.nil?
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionApi.charge" if location_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling TransactionApi.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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  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: TransactionApi#charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

ListTransactions Lists transactions for a particular location. Max results per [page](#paginatingresults): 50

Parameters:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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:



154
155
156
157
 
# File 'lib/square_connect/api/transaction_api.rb', line 154

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

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

ListTransactions Lists transactions for a particular location. Max results per [page](#paginatingresults): 50

Parameters:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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



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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/square_connect/api/transaction_api.rb', line 169

def list_transactions_with_http_info(authorization, location_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionApi.list_transactions ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling TransactionApi.list_transactions" if authorization.nil?
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionApi.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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: TransactionApi#list_transactions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

RetrieveTransaction Retrieves details for a single transaction.

Parameters:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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:



224
225
226
227
 
# File 'lib/square_connect/api/transaction_api.rb', line 224

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

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

RetrieveTransaction Retrieves details for a single transaction.

Parameters:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

  • 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:



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
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/square_connect/api/transaction_api.rb', line 236

def retrieve_transaction_with_http_info(authorization, location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionApi.retrieve_transaction ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling TransactionApi.retrieve_transaction" if authorization.nil?
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionApi.retrieve_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionApi.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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: TransactionApi#retrieve_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#void_transaction(authorization, 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

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

    the optional parameters

Returns:



286
287
288
289
 
# File 'lib/square_connect/api/transaction_api.rb', line 286

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

#void_transaction_with_http_info(authorization, 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:

  • authorization —

    The value to provide in the Authorization header of your request. This value should follow the format &#x60;Bearer YOUR_ACCESS_TOKEN_HERE&#x60;.

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

    the optional parameters

Returns:

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

    VoidTransactionResponse data, response status code and response headers



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
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/square_connect/api/transaction_api.rb', line 298

def void_transaction_with_http_info(authorization, location_id, transaction_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TransactionApi.void_transaction ..."
  end
  # verify the required parameter 'authorization' is set
  fail ArgumentError, "Missing the required parameter 'authorization' when calling TransactionApi.void_transaction" if authorization.nil?
  # verify the required parameter 'location_id' is set
  fail ArgumentError, "Missing the required parameter 'location_id' when calling TransactionApi.void_transaction" if location_id.nil?
  # verify the required parameter 'transaction_id' is set
  fail ArgumentError, "Missing the required parameter 'transaction_id' when calling TransactionApi.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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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: TransactionApi#void_transaction\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end