Class: TreezorClient::TransferApi

Inherits:
Object
  • Object
show all
Defined in:
lib/treezor_client/api/transfer_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TransferApi

Returns a new instance of TransferApi.


19
20
21
# File 'lib/treezor_client/api/transfer_api.rb', line 19

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

Instance Attribute Details

#api_clientObject

Returns the value of attribute api_client.


17
18
19
# File 'lib/treezor_client/api/transfer_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#delete_transfer(id, opts = {}) ⇒ InlineResponse20023

cancel a transfer Change transfer's status to CANCELED. A validated transfer can't be cancelled.

Parameters:

  • id

    Transfert internal id.

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

    the optional parameters

Returns:


27
28
29
30
# File 'lib/treezor_client/api/transfer_api.rb', line 27

def delete_transfer(id, opts = {})
  data, _status_code, _headers = delete_transfer_with_http_info(id, opts)
  data
end

#delete_transfer_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

cancel a transfer Change transfer&#39;s status to CANCELED. A validated transfer can&#39;t be cancelled.

Parameters:

  • id

    Transfert internal id.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20023, Fixnum, Hash)>)

    InlineResponse20023 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/treezor_client/api/transfer_api.rb', line 37

def delete_transfer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransferApi.delete_transfer ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TransferApi.delete_transfer"
  end
  # resource path
  local_var_path = '/transfers/{id}'.sub('{' + 'id' + '}', 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 = ['api_key']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse20023')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransferApi#delete_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transfer(id, opts = {}) ⇒ InlineResponse20023

get a transfer Get a transfert from the system.

Parameters:

  • id

    Transfers internal id.

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

    the optional parameters

Returns:


81
82
83
84
# File 'lib/treezor_client/api/transfer_api.rb', line 81

def get_transfer(id, opts = {})
  data, _status_code, _headers = get_transfer_with_http_info(id, opts)
  data
end

#get_transfer_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

get a transfer Get a transfert from the system.

Parameters:

  • id

    Transfers internal id.

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

    the optional parameters

Returns:

  • (Array<(InlineResponse20023, Fixnum, Hash)>)

    InlineResponse20023 data, response status code and response headers


91
92
93
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
# File 'lib/treezor_client/api/transfer_api.rb', line 91

def get_transfer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransferApi.get_transfer ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling TransferApi.get_transfer"
  end
  # resource path
  local_var_path = '/transfers/{id}'.sub('{' + 'id' + '}', 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 = ['api_key']
  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 => 'InlineResponse20023')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransferApi#get_transfer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_transfers(opts = {}) ⇒ InlineResponse20023

search transfers Search for transfers in the system. The request must contains at least one of those inputs walletId, beneficiaryWalletId, userId, beneficiaryUserId, transferId, transferTag

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :transfer_id (Integer)

    Transfer&#39;s id.

  • :transfer_tag (String)

    Custom data.

  • :transfer_status (String)

    Transfer&#39;s status. Possible values: * PENDING * CANCELED * VALIDATED

  • :wallet_id (Integer)

    Debited wallet&#39;s id.

  • :beneficiary_wallet_id (Integer)

    Credited wallet&#39;s id.

  • :user_id (Integer)

    Debited wallet user&#39;s id.

  • :beneficiary_user_id (Integer)

    Credited wallet user&#39;s id.

  • :transfer_date (DateTime)

    Transfer&#39;s date. Format : YYYY-MM-DD HH:MM:SS

  • :amount (String)

    Transfert&#39;s amount.

  • :currency (String)

    Transfert amount currency. Format: [ISO 4217](fr.wikipedia.org/wiki/ISO_4217).

  • :transfer_type_id (Integer)

    The Type Id of the Transfer: | ID | Description | |—–|—–| | 1 | Wallet to wallet | | 2 | Card transaction | | 3 | Client fees | | 4 | Credit note |

  • :page_number (Integer)

    Pagination page number. More info [here](agent.treezor.com/lists).

  • :page_count (Integer)

    The number of items per page. More info [here](agent.treezor.com/lists).

  • :sort_by (String)

    The transaction element you want to sort the list with. Default value : createdDate. More info [here](agent.treezor.com/lists).

  • :sort_order (String)

    The order you want to sort the list. * DESC for a descending sort * ASC for a ascending sort. Default value : DESC. More info [here](agent.treezor.com/lists).

  • :created_date_from (DateTime)

    The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :created_date_to (DateTime)

    The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :updated_date_from (DateTime)

    The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :updated_date_to (DateTime)

    The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

Returns:


157
158
159
160
# File 'lib/treezor_client/api/transfer_api.rb', line 157

def get_transfers(opts = {})
  data, _status_code, _headers = get_transfers_with_http_info(opts)
  data
end

#get_transfers_with_http_info(opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

search transfers Search for transfers in the system. The request must contains at least one of those inputs walletId, beneficiaryWalletId, userId, beneficiaryUserId, transferId, transferTag

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :transfer_id (Integer)

    Transfer&#39;s id.

  • :transfer_tag (String)

    Custom data.

  • :transfer_status (String)

    Transfer&#39;s status. Possible values: * PENDING * CANCELED * VALIDATED

  • :wallet_id (Integer)

    Debited wallet&#39;s id.

  • :beneficiary_wallet_id (Integer)

    Credited wallet&#39;s id.

  • :user_id (Integer)

    Debited wallet user&#39;s id.

  • :beneficiary_user_id (Integer)

    Credited wallet user&#39;s id.

  • :transfer_date (DateTime)

    Transfer&#39;s date. Format : YYYY-MM-DD HH:MM:SS

  • :amount (String)

    Transfert&#39;s amount.

  • :currency (String)

    Transfert amount currency. Format: [ISO 4217](fr.wikipedia.org/wiki/ISO_4217).

  • :transfer_type_id (Integer)

    The Type Id of the Transfer: | ID | Description | |—–|—–| | 1 | Wallet to wallet | | 2 | Card transaction | | 3 | Client fees | | 4 | Credit note |

  • :page_number (Integer)

    Pagination page number. More info [here](agent.treezor.com/lists).

  • :page_count (Integer)

    The number of items per page. More info [here](agent.treezor.com/lists).

  • :sort_by (String)

    The transaction element you want to sort the list with. Default value : createdDate. More info [here](agent.treezor.com/lists).

  • :sort_order (String)

    The order you want to sort the list. * DESC for a descending sort * ASC for a ascending sort. Default value : DESC. More info [here](agent.treezor.com/lists).

  • :created_date_from (DateTime)

    The creation date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :created_date_to (DateTime)

    The creation date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :updated_date_from (DateTime)

    The modification date from which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

  • :updated_date_to (DateTime)

    The modification date up to which you want to filter the request result. Format YYYY-MM-DD HH:MM:SS. More info [here](agent.treezor.com/lists)

Returns:

  • (Array<(InlineResponse20023, Fixnum, Hash)>)

    InlineResponse20023 data, response status code and response headers


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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
# File 'lib/treezor_client/api/transfer_api.rb', line 189

def get_transfers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransferApi.get_transfers ...'
  end
  # resource path
  local_var_path = '/transfers'

  # query parameters
  query_params = {}
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'accessTag'] = opts[:'access_tag'] if !opts[:'access_tag'].nil?
  query_params[:'accessUserId'] = opts[:'access_user_id'] if !opts[:'access_user_id'].nil?
  query_params[:'accessUserIp'] = opts[:'access_user_ip'] if !opts[:'access_user_ip'].nil?
  query_params[:'transferId'] = opts[:'transfer_id'] if !opts[:'transfer_id'].nil?
  query_params[:'transferTag'] = opts[:'transfer_tag'] if !opts[:'transfer_tag'].nil?
  query_params[:'transferStatus'] = opts[:'transfer_status'] if !opts[:'transfer_status'].nil?
  query_params[:'walletId'] = opts[:'wallet_id'] if !opts[:'wallet_id'].nil?
  query_params[:'beneficiaryWalletId'] = opts[:'beneficiary_wallet_id'] if !opts[:'beneficiary_wallet_id'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'beneficiaryUserId'] = opts[:'beneficiary_user_id'] if !opts[:'beneficiary_user_id'].nil?
  query_params[:'transferDate'] = opts[:'transfer_date'] if !opts[:'transfer_date'].nil?
  query_params[:'amount'] = opts[:'amount'] if !opts[:'amount'].nil?
  query_params[:'currency'] = opts[:'currency'] if !opts[:'currency'].nil?
  query_params[:'transferTypeId'] = opts[:'transfer_type_id'] if !opts[:'transfer_type_id'].nil?
  query_params[:'pageNumber'] = opts[:'page_number'] if !opts[:'page_number'].nil?
  query_params[:'pageCount'] = opts[:'page_count'] if !opts[:'page_count'].nil?
  query_params[:'sortBy'] = opts[:'sort_by'] if !opts[:'sort_by'].nil?
  query_params[:'sortOrder'] = opts[:'sort_order'] if !opts[:'sort_order'].nil?
  query_params[:'createdDateFrom'] = opts[:'created_date_from'] if !opts[:'created_date_from'].nil?
  query_params[:'createdDateTo'] = opts[:'created_date_to'] if !opts[:'created_date_to'].nil?
  query_params[:'updatedDateFrom'] = opts[:'updated_date_from'] if !opts[:'updated_date_from'].nil?
  query_params[:'updatedDateTo'] = opts[:'updated_date_to'] if !opts[:'updated_date_to'].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 = ['api_key']
  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 => 'InlineResponse20023')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransferApi#get_transfers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_transfers(wallet_id, beneficiary_wallet_id, amount, currency, opts = {}) ⇒ InlineResponse20023

create a transfer Create a new transfer in the system.

Parameters:

  • wallet_id

    Debited wallet&#39;s ID

  • beneficiary_wallet_id

    Credited wallet&#39;s ID

  • amount

    Transfer&#39;s amount

  • currency

    Transfert&#39;s currency. Debited wallet and credited wallet must share same currency. Format: [ISO 4217](fr.wikipedia.org/wiki/ISO_4217).

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :transfer_tag (String)

    Custom data.

  • :label (String)

    Custom data.

  • :transfer_type_id (Integer)

    The Type Id of the Transfer: | ID | Description | |—–|—–| | 1 | Wallet to wallet (default value) | | 3 | Client fees | | 4 | Credit note |

Returns:


262
263
264
265
# File 'lib/treezor_client/api/transfer_api.rb', line 262

def post_transfers(wallet_id, beneficiary_wallet_id, amount, currency, opts = {})
  data, _status_code, _headers = post_transfers_with_http_info(wallet_id, beneficiary_wallet_id, amount, currency, opts)
  data
end

#post_transfers_with_http_info(wallet_id, beneficiary_wallet_id, amount, currency, opts = {}) ⇒ Array<(InlineResponse20023, Fixnum, Hash)>

create a transfer Create a new transfer in the system.

Parameters:

  • wallet_id

    Debited wallet&#39;s ID

  • beneficiary_wallet_id

    Credited wallet&#39;s ID

  • amount

    Transfer&#39;s amount

  • currency

    Transfert&#39;s currency. Debited wallet and credited wallet must share same currency. Format: [ISO 4217](fr.wikipedia.org/wiki/ISO_4217).

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

    the optional parameters

Options Hash (opts):

  • :access_signature (String)

    Access signature can be mandatory for specific context. Treezor will contact you if so. More info [here](agent.treezor.com/security-authentication).

  • :access_tag (String)

    Access tag is used for idem potency query. More info [here](agent.treezor.com/basics).

  • :access_user_id (Integer)

    Access user&#39;s id is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String)

    Access user&#39;s ip is used for user&#39;s action restriction. More info [here](agent.treezor.com/basics).

  • :transfer_tag (String)

    Custom data.

  • :label (String)

    Custom data.

  • :transfer_type_id (Integer)

    The Type Id of the Transfer: | ID | Description | |—–|—–| | 1 | Wallet to wallet (default value) | | 3 | Client fees | | 4 | Credit note |

Returns:

  • (Array<(InlineResponse20023, Fixnum, Hash)>)

    InlineResponse20023 data, response status code and response headers


282
283
284
285
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
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/treezor_client/api/transfer_api.rb', line 282

def post_transfers_with_http_info(wallet_id, beneficiary_wallet_id, amount, currency, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TransferApi.post_transfers ...'
  end
  # verify the required parameter 'wallet_id' is set
  if @api_client.config.client_side_validation && wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'wallet_id' when calling TransferApi.post_transfers"
  end
  # verify the required parameter 'beneficiary_wallet_id' is set
  if @api_client.config.client_side_validation && beneficiary_wallet_id.nil?
    fail ArgumentError, "Missing the required parameter 'beneficiary_wallet_id' when calling TransferApi.post_transfers"
  end
  # verify the required parameter 'amount' is set
  if @api_client.config.client_side_validation && amount.nil?
    fail ArgumentError, "Missing the required parameter 'amount' when calling TransferApi.post_transfers"
  end
  # verify the required parameter 'currency' is set
  if @api_client.config.client_side_validation && currency.nil?
    fail ArgumentError, "Missing the required parameter 'currency' when calling TransferApi.post_transfers"
  end
  # resource path
  local_var_path = '/transfers'

  # query parameters
  query_params = {}
  query_params[:'walletId'] = wallet_id
  query_params[:'beneficiaryWalletId'] = beneficiary_wallet_id
  query_params[:'amount'] = amount
  query_params[:'currency'] = currency
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'accessTag'] = opts[:'access_tag'] if !opts[:'access_tag'].nil?
  query_params[:'accessUserId'] = opts[:'access_user_id'] if !opts[:'access_user_id'].nil?
  query_params[:'accessUserIp'] = opts[:'access_user_ip'] if !opts[:'access_user_ip'].nil?
  query_params[:'transferTag'] = opts[:'transfer_tag'] if !opts[:'transfer_tag'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?
  query_params[:'transferTypeId'] = opts[:'transfer_type_id'] if !opts[:'transfer_type_id'].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 = ['api_key']
  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 => 'InlineResponse20023')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TransferApi#post_transfers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end