Class: TreezorClient::CardApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CardApi

Returns a new instance of CardApi.



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

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



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

def api_client
  @api_client
end

Instance Method Details

#cardimages_get(card_id, opts = {}) ⇒ InlineResponse2006

get a card image Return virtual card’s image

Parameters:

  • card_id —

    Vitual card's id.

  • 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's id is used for user's action restriction. More info [here](agent.treezor.com/basics).

  • :access_user_ip (String) —

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

Returns:



31
32
33
34
 
# File 'lib/treezor_client/api/card_api.rb', line 31

def cardimages_get(card_id, opts = {})
  data, _status_code, _headers = cardimages_get_with_http_info(card_id, opts)
  data
end

#cardimages_get_with_http_info(card_id, opts = {}) ⇒ Array<(InlineResponse2006, Fixnum, Hash)>

get a card image Return virtual card&#39;s image

Parameters:

  • card_id —

    Vitual card&#39;s id.

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

Returns:

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

    InlineResponse2006 data, response status code and response headers



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
81
82
83
84
 
# File 'lib/treezor_client/api/card_api.rb', line 45

def cardimages_get_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cardimages_get ...'
  end
  # verify the required parameter 'card_id' is set
  if @api_client.config.client_side_validation && card_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_id' when calling CardApi.cardimages_get"
  end
  # resource path
  local_var_path = '/cardimages'

  # query parameters
  query_params = {}
  query_params[:'cardId'] = card_id
  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?

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2006')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cardimages_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_create_virtual_post(user_id, wallet_id, perms_group, card_print, opts = {}) ⇒ InlineResponse2005

create a virtual card Create a new virtual card. To use a card you will need to activate it (/cards/id/Activate/).

Parameters:

  • user_id —

    User&#39;s id of cardholder

  • wallet_id —

    Wallet&#39;s Id in which to create the card

  • perms_group —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • card_print —

    Card appareance code, also used to choose the program ID of the card

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

  • :card_tag (String) —

    Custom field

  • :batch_delivery_id (Integer) —

    Batch regroupement identifier (must be between 1 and 238327) NOT YET OPERATIONAL

  • :limit_atm_year (Integer) —

    ATM operations limit for a sliding year. No default value.

  • :limit_atm_month (Integer) —

    ATM operations limit for a sliding month. No default value.

  • :limit_atm_week (Integer) —

    ATM operations limit for a sliding week. Default value 2000€.

  • :limit_atm_day (Integer) —

    ATM operations limit for a single day. Default value 1000€.

  • :limit_atm_all (Integer) —

    ATM operations limit from beginning. No default value.

  • :limit_payment_year (Integer) —

    POS operations limit for a sliding year. No default value.

  • :limit_payment_month (Integer) —

    POS operations limit for a sliding month. No default value.

  • :limit_payment_week (Integer) —

    POS operations limit for a sliding week. Default value 3000€.

  • :limit_payment_day (Integer) —

    POS operations limit for a single day. Default value 2000€.

  • :limit_payment_all (Integer) —

    POS operations limit from beginning. No default value.

  • :payment_daily_limit (Float) —

    POS operations limit for a single day including cents. The decimal delimiter must be &quot;.&quot;. No default value.

  • :pin (String) —

    Card&#39;s PIN code value.

  • :anonymous (Integer) —

    Card is anonymous. If value is 1 there will be no embossed name.

  • :send_to_parent (Integer) —

    If you put the value 1 the delivery address will be the parent user&#39;s.

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId you want to apply

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId you want to apply

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId you want to apply

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

Returns:



116
117
118
119
 
# File 'lib/treezor_client/api/card_api.rb', line 116

def cards_create_virtual_post(user_id, wallet_id, perms_group, card_print, opts = {})
  data, _status_code, _headers = cards_create_virtual_post_with_http_info(user_id, wallet_id, perms_group, card_print, opts)
  data
end

#cards_create_virtual_post_with_http_info(user_id, wallet_id, perms_group, card_print, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

create a virtual card Create a new virtual card. To use a card you will need to activate it (/cards/id/Activate/).

Parameters:

  • user_id —

    User&#39;s id of cardholder

  • wallet_id —

    Wallet&#39;s Id in which to create the card

  • perms_group —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • card_print —

    Card appareance code, also used to choose the program ID of the card

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

  • :card_tag (String) —

    Custom field

  • :batch_delivery_id (Integer) —

    Batch regroupement identifier (must be between 1 and 238327) NOT YET OPERATIONAL

  • :limit_atm_year (Integer) —

    ATM operations limit for a sliding year. No default value.

  • :limit_atm_month (Integer) —

    ATM operations limit for a sliding month. No default value.

  • :limit_atm_week (Integer) —

    ATM operations limit for a sliding week. Default value 2000€.

  • :limit_atm_day (Integer) —

    ATM operations limit for a single day. Default value 1000€.

  • :limit_atm_all (Integer) —

    ATM operations limit from beginning. No default value.

  • :limit_payment_year (Integer) —

    POS operations limit for a sliding year. No default value.

  • :limit_payment_month (Integer) —

    POS operations limit for a sliding month. No default value.

  • :limit_payment_week (Integer) —

    POS operations limit for a sliding week. Default value 3000€.

  • :limit_payment_day (Integer) —

    POS operations limit for a single day. Default value 2000€.

  • :limit_payment_all (Integer) —

    POS operations limit from beginning. No default value.

  • :payment_daily_limit (Float) —

    POS operations limit for a single day including cents. The decimal delimiter must be &quot;.&quot;. No default value.

  • :pin (String) —

    Card&#39;s PIN code value.

  • :anonymous (Integer) —

    Card is anonymous. If value is 1 there will be no embossed name.

  • :send_to_parent (Integer) —

    If you put the value 1 the delivery address will be the parent user&#39;s.

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId you want to apply

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId you want to apply

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId you want to apply

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



152
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
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
 
# File 'lib/treezor_client/api/card_api.rb', line 152

def cards_create_virtual_post_with_http_info(user_id, wallet_id, perms_group, card_print, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_create_virtual_post ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling CardApi.cards_create_virtual_post"
  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 CardApi.cards_create_virtual_post"
  end
  # verify the required parameter 'perms_group' is set
  if @api_client.config.client_side_validation && perms_group.nil?
    fail ArgumentError, "Missing the required parameter 'perms_group' when calling CardApi.cards_create_virtual_post"
  end
  # verify the required parameter 'card_print' is set
  if @api_client.config.client_side_validation && card_print.nil?
    fail ArgumentError, "Missing the required parameter 'card_print' when calling CardApi.cards_create_virtual_post"
  end
  # resource path
  local_var_path = '/cards/CreateVirtual'

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'walletId'] = wallet_id
  query_params[:'permsGroup'] = perms_group
  query_params[:'cardPrint'] = card_print
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'cardTag'] = opts[:'card_tag'] if !opts[:'card_tag'].nil?
  query_params[:'batchDeliveryId'] = opts[:'batch_delivery_id'] if !opts[:'batch_delivery_id'].nil?
  query_params[:'limitAtmYear'] = opts[:'limit_atm_year'] if !opts[:'limit_atm_year'].nil?
  query_params[:'limitAtmMonth'] = opts[:'limit_atm_month'] if !opts[:'limit_atm_month'].nil?
  query_params[:'limitAtmWeek'] = opts[:'limit_atm_week'] if !opts[:'limit_atm_week'].nil?
  query_params[:'limitAtmDay'] = opts[:'limit_atm_day'] if !opts[:'limit_atm_day'].nil?
  query_params[:'limitAtmAll'] = opts[:'limit_atm_all'] if !opts[:'limit_atm_all'].nil?
  query_params[:'limitPaymentYear'] = opts[:'limit_payment_year'] if !opts[:'limit_payment_year'].nil?
  query_params[:'limitPaymentMonth'] = opts[:'limit_payment_month'] if !opts[:'limit_payment_month'].nil?
  query_params[:'limitPaymentWeek'] = opts[:'limit_payment_week'] if !opts[:'limit_payment_week'].nil?
  query_params[:'limitPaymentDay'] = opts[:'limit_payment_day'] if !opts[:'limit_payment_day'].nil?
  query_params[:'limitPaymentAll'] = opts[:'limit_payment_all'] if !opts[:'limit_payment_all'].nil?
  query_params[:'paymentDailyLimit'] = opts[:'payment_daily_limit'] if !opts[:'payment_daily_limit'].nil?
  query_params[:'pin'] = opts[:'pin'] if !opts[:'pin'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'sendToParent'] = opts[:'send_to_parent'] if !opts[:'send_to_parent'].nil?
  query_params[:'mccRestrictionGroupId'] = opts[:'mcc_restriction_group_id'] if !opts[:'mcc_restriction_group_id'].nil?
  query_params[:'merchantRestrictionGroupId'] = opts[:'merchant_restriction_group_id'] if !opts[:'merchant_restriction_group_id'].nil?
  query_params[:'countryRestrictionGroupId'] = opts[:'country_restriction_group_id'] if !opts[:'country_restriction_group_id'].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?

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_create_virtual_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_get(opts = {}) ⇒ InlineResponse2005

search cards

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

  • :card_id (Integer) —

    Card&#39;s id

  • :user_id (Integer) —

    User&#39;s id of cardholder

  • :embossed_name (String) —

    Embossed name of the card

  • :public_token (String) —

    Public token of the card

  • :perms_group (String) —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • :is_physical (Integer) —

    | Value | Type | | — | — | | 1 | Physical card| | 0 | Virtual card |

  • :is_converted (Integer) —

    | Value | Type | | — | — | | 1 | Physical card converted in a virtual card| | 0 | Not converted |

  • :lock_status (Integer) —

    | Value | Type | | — | — | | 1 | Card blocked | | 0 | Card Unblocked | | 2 | Lost card | | 3 | Stolen card |

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId of the card

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId of the card

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId of the card

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



252
253
254
255
 
# File 'lib/treezor_client/api/card_api.rb', line 252

def cards_get(opts = {})
  data, _status_code, _headers = cards_get_with_http_info(opts)
  data
end

#cards_get_with_http_info(opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

search cards

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

  • :card_id (Integer) —

    Card&#39;s id

  • :user_id (Integer) —

    User&#39;s id of cardholder

  • :embossed_name (String) —

    Embossed name of the card

  • :public_token (String) —

    Public token of the card

  • :perms_group (String) —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • :is_physical (Integer) —

    | Value | Type | | — | — | | 1 | Physical card| | 0 | Virtual card |

  • :is_converted (Integer) —

    | Value | Type | | — | — | | 1 | Physical card converted in a virtual card| | 0 | Not converted |

  • :lock_status (Integer) —

    | Value | Type | | — | — | | 1 | Card blocked | | 0 | Card Unblocked | | 2 | Lost card | | 3 | Stolen card |

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId of the card

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId of the card

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId of the card

  • :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<(InlineResponse2005, Fixnum, Hash)>) —

    InlineResponse2005 data, response status code and response headers



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
 
# File 'lib/treezor_client/api/card_api.rb', line 283

def cards_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_get ...'
  end
  # resource path
  local_var_path = '/cards'

  # 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[:'cardId'] = opts[:'card_id'] if !opts[:'card_id'].nil?
  query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
  query_params[:'embossedName'] = opts[:'embossed_name'] if !opts[:'embossed_name'].nil?
  query_params[:'publicToken'] = opts[:'public_token'] if !opts[:'public_token'].nil?
  query_params[:'permsGroup'] = opts[:'perms_group'] if !opts[:'perms_group'].nil?
  query_params[:'isPhysical'] = opts[:'is_physical'] if !opts[:'is_physical'].nil?
  query_params[:'isConverted'] = opts[:'is_converted'] if !opts[:'is_converted'].nil?
  query_params[:'lockStatus'] = opts[:'lock_status'] if !opts[:'lock_status'].nil?
  query_params[:'mccRestrictionGroupId'] = opts[:'mcc_restriction_group_id'] if !opts[:'mcc_restriction_group_id'].nil?
  query_params[:'merchantRestrictionGroupId'] = opts[:'merchant_restriction_group_id'] if !opts[:'merchant_restriction_group_id'].nil?
  query_params[:'countryRestrictionGroupId'] = opts[:'country_restriction_group_id'] if !opts[:'country_restriction_group_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 = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_id_activate_put(id, opts = {}) ⇒ InlineResponse2005

activate a card The Activate endpoint change card status to activate. An activated card can be freely used.

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Options Hash (opts):

Returns:



347
348
349
350
 
# File 'lib/treezor_client/api/card_api.rb', line 347

def cards_id_activate_put(id, opts = {})
  data, _status_code, _headers = cards_id_activate_put_with_http_info(id, opts)
  data
end

#cards_id_activate_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

activate a card The Activate endpoint change card status to activate. An activated card can be freely used.

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse2005 data, response status code and response headers



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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/treezor_client/api/card_api.rb', line 362

def cards_id_activate_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_activate_put ...'
  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 CardApi.cards_id_activate_put"
  end
  # resource path
  local_var_path = '/cards/{id}/Activate/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'accessToken'] = opts[:'access_token'] if !opts[:'access_token'].nil?
  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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_change_pin_put(id, current_pin, new_pin, confirm_pin, opts = {}) ⇒ InlineResponse2005

change card’s PIN Change card’s PIN code knowing the current one.

Parameters:

  • id —

    Card&#39;s id.

  • current_pin —

    Card&#39;s current PIN

  • new_pin —

    Card&#39;s new PIN

  • confirm_pin —

    Card&#39;s new PIN confirmation value

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

Returns:



414
415
416
417
 
# File 'lib/treezor_client/api/card_api.rb', line 414

def cards_id_change_pin_put(id, current_pin, new_pin, confirm_pin, opts = {})
  data, _status_code, _headers = cards_id_change_pin_put_with_http_info(id, current_pin, new_pin, confirm_pin, opts)
  data
end

#cards_id_change_pin_put_with_http_info(id, current_pin, new_pin, confirm_pin, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

change card&#39;s PIN Change card&#39;s PIN code knowing the current one.

Parameters:

  • id —

    Card&#39;s id.

  • current_pin —

    Card&#39;s current PIN

  • new_pin —

    Card&#39;s new PIN

  • confirm_pin —

    Card&#39;s new PIN confirmation value

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
 
# File 'lib/treezor_client/api/card_api.rb', line 431

def cards_id_change_pin_put_with_http_info(id, current_pin, new_pin, confirm_pin, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_change_pin_put ...'
  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 CardApi.cards_id_change_pin_put"
  end
  # verify the required parameter 'current_pin' is set
  if @api_client.config.client_side_validation && current_pin.nil?
    fail ArgumentError, "Missing the required parameter 'current_pin' when calling CardApi.cards_id_change_pin_put"
  end
  # verify the required parameter 'new_pin' is set
  if @api_client.config.client_side_validation && new_pin.nil?
    fail ArgumentError, "Missing the required parameter 'new_pin' when calling CardApi.cards_id_change_pin_put"
  end
  # verify the required parameter 'confirm_pin' is set
  if @api_client.config.client_side_validation && confirm_pin.nil?
    fail ArgumentError, "Missing the required parameter 'confirm_pin' when calling CardApi.cards_id_change_pin_put"
  end
  # resource path
  local_var_path = '/cards/{id}/ChangePIN/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'currentPIN'] = current_pin
  query_params[:'newPIN'] = new_pin
  query_params[:'confirmPIN'] = confirm_pin
  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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_convert_virtual_put(id, opts = {}) ⇒ InlineResponse2005

convert card to virtual Convert a virtual card into a physical one. The converted card will be both virtual and physical.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:



494
495
496
497
 
# File 'lib/treezor_client/api/card_api.rb', line 494

def cards_id_convert_virtual_put(id, opts = {})
  data, _status_code, _headers = cards_id_convert_virtual_put_with_http_info(id, opts)
  data
end

#cards_id_convert_virtual_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

convert card to virtual Convert a virtual card into a physical one. The converted card will be both virtual and physical.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/treezor_client/api/card_api.rb', line 508

def cards_id_convert_virtual_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_convert_virtual_put ...'
  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 CardApi.cards_id_convert_virtual_put"
  end
  # resource path
  local_var_path = '/cards/{id}/ConvertVirtual/'.sub('{' + 'id' + '}', id.to_s)

  # 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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_delete(id, opts = {}) ⇒ InlineResponse2005

deactivate a card

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Returns:



551
552
553
554
 
# File 'lib/treezor_client/api/card_api.rb', line 551

def cards_id_delete(id, opts = {})
  data, _status_code, _headers = cards_id_delete_with_http_info(id, opts)
  data
end

#cards_id_delete_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

deactivate a card

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Returns:

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

    InlineResponse2005 data, response status code and response headers



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
 
# File 'lib/treezor_client/api/card_api.rb', line 560

def cards_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_delete ...'
  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 CardApi.cards_id_delete"
  end
  # resource path
  local_var_path = '/cards/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_id_get(id, opts = {}) ⇒ InlineResponse2005

get a card

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Returns:



599
600
601
602
 
# File 'lib/treezor_client/api/card_api.rb', line 599

def cards_id_get(id, opts = {})
  data, _status_code, _headers = cards_id_get_with_http_info(id, opts)
  data
end

#cards_id_get_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

get a card

Parameters:

  • id —

    Card&#39;s id.

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

    the optional parameters

Returns:

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

    InlineResponse2005 data, response status code and response headers



608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
 
# File 'lib/treezor_client/api/card_api.rb', line 608

def cards_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_get ...'
  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 CardApi.cards_id_get"
  end
  # resource path
  local_var_path = '/cards/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_id_limits_put(id, opts = {}) ⇒ InlineResponse2005

update card’s limits Update of the card limits.

Parameters:

  • id —

    Card&#39;s id.

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

  • :limit_atm_year (Integer) —

    ATM year limit

  • :limit_atm_month (Integer) —

    ATM month limit

  • :limit_atm_week (Integer) —

    ATM week limit

  • :limit_atm_day (Integer) —

    ATM day limit

  • :limit_atm_all (Integer) —

    ATM from beginning limit

  • :limit_payment_year (Integer) —

    Payment year limit

  • :limit_payment_month (Integer) —

    Payment month limit

  • :limit_payment_week (Integer) —

    Payment week limit

  • :limit_payment_day (Integer) —

    Payment day limit

  • :limit_payment_all (Integer) —

    Payment from beginning limit

  • :payment_daily_limit (Float) —

    Payment day limit including cents. The decimal delimiter must be &quot;.&quot;

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

Returns:



663
664
665
666
 
# File 'lib/treezor_client/api/card_api.rb', line 663

def cards_id_limits_put(id, opts = {})
  data, _status_code, _headers = cards_id_limits_put_with_http_info(id, opts)
  data
end

#cards_id_limits_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

update card&#39;s limits Update of the card limits.

Parameters:

  • id —

    Card&#39;s id.

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

  • :limit_atm_year (Integer) —

    ATM year limit

  • :limit_atm_month (Integer) —

    ATM month limit

  • :limit_atm_week (Integer) —

    ATM week limit

  • :limit_atm_day (Integer) —

    ATM day limit

  • :limit_atm_all (Integer) —

    ATM from beginning limit

  • :limit_payment_year (Integer) —

    Payment year limit

  • :limit_payment_month (Integer) —

    Payment month limit

  • :limit_payment_week (Integer) —

    Payment week limit

  • :limit_payment_day (Integer) —

    Payment day limit

  • :limit_payment_all (Integer) —

    Payment from beginning limit

  • :payment_daily_limit (Float) —

    Payment day limit including cents. The decimal delimiter must be &quot;.&quot;

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
 
# File 'lib/treezor_client/api/card_api.rb', line 688

def cards_id_limits_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_limits_put ...'
  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 CardApi.cards_id_limits_put"
  end
  # resource path
  local_var_path = '/cards/{id}/Limits/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'limitAtmYear'] = opts[:'limit_atm_year'] if !opts[:'limit_atm_year'].nil?
  query_params[:'limitAtmMonth'] = opts[:'limit_atm_month'] if !opts[:'limit_atm_month'].nil?
  query_params[:'limitAtmWeek'] = opts[:'limit_atm_week'] if !opts[:'limit_atm_week'].nil?
  query_params[:'limitAtmDay'] = opts[:'limit_atm_day'] if !opts[:'limit_atm_day'].nil?
  query_params[:'limitAtmAll'] = opts[:'limit_atm_all'] if !opts[:'limit_atm_all'].nil?
  query_params[:'limitPaymentYear'] = opts[:'limit_payment_year'] if !opts[:'limit_payment_year'].nil?
  query_params[:'limitPaymentMonth'] = opts[:'limit_payment_month'] if !opts[:'limit_payment_month'].nil?
  query_params[:'limitPaymentWeek'] = opts[:'limit_payment_week'] if !opts[:'limit_payment_week'].nil?
  query_params[:'limitPaymentDay'] = opts[:'limit_payment_day'] if !opts[:'limit_payment_day'].nil?
  query_params[:'limitPaymentAll'] = opts[:'limit_payment_all'] if !opts[:'limit_payment_all'].nil?
  query_params[:'paymentDailyLimit'] = opts[:'payment_daily_limit'] if !opts[:'payment_daily_limit'].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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_lock_unlock_put(id, lock_status, opts = {}) ⇒ InlineResponse2005

update card’s blocking status Block or unblock a card.

Parameters:

  • id —

    Card&#39;s id.

  • lock_status —

    | Value | Type | | — | — | | 1 | Block the card| | 0 | Unblock the card | | 2 | Lost card | | 3 | Stolen card |

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

Returns:



748
749
750
751
 
# File 'lib/treezor_client/api/card_api.rb', line 748

def cards_id_lock_unlock_put(id, lock_status, opts = {})
  data, _status_code, _headers = cards_id_lock_unlock_put_with_http_info(id, lock_status, opts)
  data
end

#cards_id_lock_unlock_put_with_http_info(id, lock_status, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

update card&#39;s blocking status Block or unblock a card.

Parameters:

  • id —

    Card&#39;s id.

  • lock_status —

    | Value | Type | | — | — | | 1 | Block the card| | 0 | Unblock the card | | 2 | Lost card | | 3 | Stolen card |

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
 
# File 'lib/treezor_client/api/card_api.rb', line 763

def cards_id_lock_unlock_put_with_http_info(id, lock_status, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_lock_unlock_put ...'
  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 CardApi.cards_id_lock_unlock_put"
  end
  # verify the required parameter 'lock_status' is set
  if @api_client.config.client_side_validation && lock_status.nil?
    fail ArgumentError, "Missing the required parameter 'lock_status' when calling CardApi.cards_id_lock_unlock_put"
  end
  # resource path
  local_var_path = '/cards/{id}/LockUnlock/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'lockStatus'] = lock_status
  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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_options_put(id, foreign, online, atm, nfc, opts = {}) ⇒ InlineResponse2005

update card’s options Allows to update card’s permission group.

Parameters:

  • id —

    Card&#39;s id.

  • foreign —

    Card usable abroad

  • online —

    Card usable on-line

  • atm —

    Card usable on ATM (withdrawals)

  • nfc —

    Card usable on contactless compatible POS machine machine&quot;

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

Returns:



820
821
822
823
 
# File 'lib/treezor_client/api/card_api.rb', line 820

def cards_id_options_put(id, foreign, online, atm, nfc, opts = {})
  data, _status_code, _headers = cards_id_options_put_with_http_info(id, foreign, online, atm, nfc, opts)
  data
end

#cards_id_options_put_with_http_info(id, foreign, online, atm, nfc, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

update card&#39;s options Allows to update card&#39;s permission group.

Parameters:

  • id —

    Card&#39;s id.

  • foreign —

    Card usable abroad

  • online —

    Card usable on-line

  • atm —

    Card usable on ATM (withdrawals)

  • nfc —

    Card usable on contactless compatible POS machine machine&quot;

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
 
# File 'lib/treezor_client/api/card_api.rb', line 838

def cards_id_options_put_with_http_info(id, foreign, online, atm, nfc, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_options_put ...'
  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 CardApi.cards_id_options_put"
  end
  # verify the required parameter 'foreign' is set
  if @api_client.config.client_side_validation && foreign.nil?
    fail ArgumentError, "Missing the required parameter 'foreign' when calling CardApi.cards_id_options_put"
  end
  # verify the required parameter 'online' is set
  if @api_client.config.client_side_validation && online.nil?
    fail ArgumentError, "Missing the required parameter 'online' when calling CardApi.cards_id_options_put"
  end
  # verify the required parameter 'atm' is set
  if @api_client.config.client_side_validation && atm.nil?
    fail ArgumentError, "Missing the required parameter 'atm' when calling CardApi.cards_id_options_put"
  end
  # verify the required parameter 'nfc' is set
  if @api_client.config.client_side_validation && nfc.nil?
    fail ArgumentError, "Missing the required parameter 'nfc' when calling CardApi.cards_id_options_put"
  end
  # resource path
  local_var_path = '/cards/{id}/Options/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'foreign'] = foreign
  query_params[:'online'] = online
  query_params[:'atm'] = atm
  query_params[:'nfc'] = nfc
  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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_put(id, opts = {}) ⇒ InlineResponse2005

update card informations Actually update mccRestrictionGroupId and merchantRestrictionGroupId of a card

Parameters:

  • id —

    Card&#39;s id.

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

  • :mcc_restriction_group_id (Integer) —

    card&#39;s mccRestrictionGroupId

  • :merchant_restriction_group_id (Integer) —

    card&#39;s merchantRestrictionGroupId

  • :country_restriction_group_id (Integer) —

    card&#39;s countryRestrictionGroupId

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

Returns:



909
910
911
912
 
# File 'lib/treezor_client/api/card_api.rb', line 909

def cards_id_put(id, opts = {})
  data, _status_code, _headers = cards_id_put_with_http_info(id, opts)
  data
end

#cards_id_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

update card informations Actually update mccRestrictionGroupId and merchantRestrictionGroupId of a card

Parameters:

  • id —

    Card&#39;s id.

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

  • :mcc_restriction_group_id (Integer) —

    card&#39;s mccRestrictionGroupId

  • :merchant_restriction_group_id (Integer) —

    card&#39;s merchantRestrictionGroupId

  • :country_restriction_group_id (Integer) —

    card&#39;s countryRestrictionGroupId

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
 
# File 'lib/treezor_client/api/card_api.rb', line 926

def cards_id_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_put ...'
  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 CardApi.cards_id_put"
  end
  # resource path
  local_var_path = '/cards/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'mccRestrictionGroupId'] = opts[:'mcc_restriction_group_id'] if !opts[:'mcc_restriction_group_id'].nil?
  query_params[:'merchantRestrictionGroupId'] = opts[:'merchant_restriction_group_id'] if !opts[:'merchant_restriction_group_id'].nil?
  query_params[:'countryRestrictionGroupId'] = opts[:'country_restriction_group_id'] if !opts[:'country_restriction_group_id'].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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_regenerate_put(id, opts = {}) ⇒ InlineResponse2005

regenerate card If card is Lost or Stolen (card’s status), the card itself will get regenerated. Otherwise only the card image gets recreated.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:



977
978
979
980
 
# File 'lib/treezor_client/api/card_api.rb', line 977

def cards_id_regenerate_put(id, opts = {})
  data, _status_code, _headers = cards_id_regenerate_put_with_http_info(id, opts)
  data
end

#cards_id_regenerate_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

regenerate card If card is Lost or Stolen (card&#39;s status), the card itself will get regenerated. Otherwise only the card image gets recreated.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
 
# File 'lib/treezor_client/api/card_api.rb', line 991

def cards_id_regenerate_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_regenerate_put ...'
  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 CardApi.cards_id_regenerate_put"
  end
  # resource path
  local_var_path = '/cards/{id}/Regenerate/'.sub('{' + 'id' + '}', id.to_s)

  # 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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_set_pin_put(id, new_pin, confirm_pin, opts = {}) ⇒ InlineResponse2005

set card’s PIN Overwrite card’s PIN.

Parameters:

  • id —

    Card&#39;s id.

  • new_pin —

    Card&#39;s new PIN.

  • confirm_pin —

    Card&#39;s new PIN confirmation value

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

Returns:



1041
1042
1043
1044
 
# File 'lib/treezor_client/api/card_api.rb', line 1041

def cards_id_set_pin_put(id, new_pin, confirm_pin, opts = {})
  data, _status_code, _headers = cards_id_set_pin_put_with_http_info(id, new_pin, confirm_pin, opts)
  data
end

#cards_id_set_pin_put_with_http_info(id, new_pin, confirm_pin, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

set card&#39;s PIN Overwrite card&#39;s PIN.

Parameters:

  • id —

    Card&#39;s id.

  • new_pin —

    Card&#39;s new PIN.

  • confirm_pin —

    Card&#39;s new PIN confirmation value

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
 
# File 'lib/treezor_client/api/card_api.rb', line 1057

def cards_id_set_pin_put_with_http_info(id, new_pin, confirm_pin, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_set_pin_put ...'
  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 CardApi.cards_id_set_pin_put"
  end
  # verify the required parameter 'new_pin' is set
  if @api_client.config.client_side_validation && new_pin.nil?
    fail ArgumentError, "Missing the required parameter 'new_pin' when calling CardApi.cards_id_set_pin_put"
  end
  # verify the required parameter 'confirm_pin' is set
  if @api_client.config.client_side_validation && confirm_pin.nil?
    fail ArgumentError, "Missing the required parameter 'confirm_pin' when calling CardApi.cards_id_set_pin_put"
  end
  # resource path
  local_var_path = '/cards/{id}/setPIN/'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'newPIN'] = new_pin
  query_params[:'confirmPIN'] = confirm_pin
  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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_id_unblock_pin_put(id, opts = {}) ⇒ InlineResponse2005

unblock card’s PIN Unblock card’s PIN code.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:



1115
1116
1117
1118
 
# File 'lib/treezor_client/api/card_api.rb', line 1115

def cards_id_unblock_pin_put(id, opts = {})
  data, _status_code, _headers = cards_id_unblock_pin_put_with_http_info(id, opts)
  data
end

#cards_id_unblock_pin_put_with_http_info(id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

unblock card&#39;s PIN Unblock card&#39;s PIN code.

Parameters:

  • id —

    Card&#39;s id.

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
 
# File 'lib/treezor_client/api/card_api.rb', line 1129

def cards_id_unblock_pin_put_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_id_unblock_pin_put ...'
  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 CardApi.cards_id_unblock_pin_put"
  end
  # resource path
  local_var_path = '/cards/{id}/UnblockPIN/'.sub('{' + 'id' + '}', id.to_s)

  # 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?

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

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

#cards_register3_ds_post(card_id, opts = {}) ⇒ InlineResponse2005

Register 3D secure Register a card to 3D secure service. The user’s mobile number must begin by "+", or "00", and the country dialing code.

Parameters:

  • card_id —

    Card&#39;s ID to register

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

    the optional parameters

Options Hash (opts):

Returns:



1174
1175
1176
1177
 
# File 'lib/treezor_client/api/card_api.rb', line 1174

def cards_register3_ds_post(card_id, opts = {})
  data, _status_code, _headers = cards_register3_ds_post_with_http_info(card_id, opts)
  data
end

#cards_register3_ds_post_with_http_info(card_id, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

Register 3D secure Register a card to 3D secure service. The user&#39;s mobile number must begin by &quot;+&quot;, or &quot;00&quot;, and the country dialing code.

Parameters:

  • card_id —

    Card&#39;s ID to register

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

    the optional parameters

Options Hash (opts):

Returns:

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

    InlineResponse2005 data, response status code and response headers



1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/treezor_client/api/card_api.rb', line 1185

def cards_register3_ds_post_with_http_info(card_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_register3_ds_post ...'
  end
  # verify the required parameter 'card_id' is set
  if @api_client.config.client_side_validation && card_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_id' when calling CardApi.cards_register3_ds_post"
  end
  # resource path
  local_var_path = '/cards/Register3DS'

  # query parameters
  query_params = {}
  query_params[:'cardId'] = card_id
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_register3_ds_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#cards_request_physical_post(user_id, wallet_id, perms_group, card_tag, card_print, opts = {}) ⇒ InlineResponse2005

create a physical card Create a new physical card. To use a card you will need to activate it (/cards/id/Activate/).

Parameters:

  • user_id —

    User&#39;s id of cardholder

  • wallet_id —

    Wallet&#39;s Id in which to create the card

  • perms_group —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • card_tag —

    Custom field

  • card_print —

    Card appearance code, also used to choose the program ID of the card

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

  • :batch_delivery_id (Integer) —

    Batch regroupement identifier (must be between 1 and 238327) NOT YET OPERATIONAL

  • :limit_atm_year (Integer) —

    ATM operations limit for a sliding year. No default value.

  • :limit_atm_month (Integer) —

    ATM operations limit for a sliding month. No default value.

  • :limit_atm_week (Integer) —

    ATM operations limit for a sliding week. Default value 2000€.

  • :limit_atm_day (Integer) —

    ATM operations limit for a single day. Default value 1000€.

  • :limit_atm_all (Integer) —

    ATM operations limit from beginning. No default value.

  • :limit_payment_year (Integer) —

    POS operations limit for a sliding year. No default value.

  • :limit_payment_month (Integer) —

    POS operations limit for a sliding month. No default value.

  • :limit_payment_week (Integer) —

    POS operations limit for a sliding week. Default value 3000€.

  • :limit_payment_day (Integer) —

    POS operations limit for a single day. Default value 2000€.

  • :limit_payment_all (Integer) —

    POS operations limit from beginning. No default value.

  • :payment_daily_limit (Float) —

    POS operations limit for a single day including cents. The decimal delimiter must be &quot;.&quot;. No default value.

  • :pin (String) —

    Card&#39;s PIN code value. Default random PIN.

  • :anonymous (Integer) —

    Card is anonymous. If value is 1 there will be no embossed name.

  • :send_to_parent (Integer) —

    If you put the value 1 the delivery address will be the parent user&#39;s.

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId you want to apply

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId you want to apply

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId you want to apply

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

Returns:



1253
1254
1255
1256
 
# File 'lib/treezor_client/api/card_api.rb', line 1253

def cards_request_physical_post(user_id, wallet_id, perms_group, card_tag, card_print, opts = {})
  data, _status_code, _headers = cards_request_physical_post_with_http_info(user_id, wallet_id, perms_group, card_tag, card_print, opts)
  data
end

#cards_request_physical_post_with_http_info(user_id, wallet_id, perms_group, card_tag, card_print, opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

create a physical card Create a new physical card. To use a card you will need to activate it (/cards/id/Activate/).

Parameters:

  • user_id —

    User&#39;s id of cardholder

  • wallet_id —

    Wallet&#39;s Id in which to create the card

  • perms_group —

    Permissions group of the card. There is 4 usages which create 16 possible groups: | group | NFC | ATM | On-line | Foreign | |—–|—–|—–|—–|——| |TRZ-CU-001|KO|KO|KO|KO| |TRZ-CU-002|KO|KO|KO|OK| |TRZ-CU-003|KO|KO|OK|KO| |TRZ-CU-004|KO|KO|OK|OK| |TRZ-CU-005|KO|OK|KO|KO| |TRZ-CU-006|KO|OK|KO|OK| |TRZ-CU-007|KO|OK|OK|KO| |TRZ-CU-008|KO|OK|OK|OK| |TRZ-CU-009|OK|KO|KO|KO| |TRZ-CU-010|OK|KO|KO|OK| |TRZ-CU-011|OK|KO|OK|KO| |TRZ-CU-012|OK|KO|OK|OK| |TRZ-CU-013|OK|OK|KO|KO| |TRZ-CU-014|OK|OK|KO|OK| |TRZ-CU-015|OK|OK|OK|KO| |TRZ-CU-016|OK|OK|OK|OK|

  • card_tag —

    Custom field

  • card_print —

    Card appearance code, also used to choose the program ID of the card

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

  • :batch_delivery_id (Integer) —

    Batch regroupement identifier (must be between 1 and 238327) NOT YET OPERATIONAL

  • :limit_atm_year (Integer) —

    ATM operations limit for a sliding year. No default value.

  • :limit_atm_month (Integer) —

    ATM operations limit for a sliding month. No default value.

  • :limit_atm_week (Integer) —

    ATM operations limit for a sliding week. Default value 2000€.

  • :limit_atm_day (Integer) —

    ATM operations limit for a single day. Default value 1000€.

  • :limit_atm_all (Integer) —

    ATM operations limit from beginning. No default value.

  • :limit_payment_year (Integer) —

    POS operations limit for a sliding year. No default value.

  • :limit_payment_month (Integer) —

    POS operations limit for a sliding month. No default value.

  • :limit_payment_week (Integer) —

    POS operations limit for a sliding week. Default value 3000€.

  • :limit_payment_day (Integer) —

    POS operations limit for a single day. Default value 2000€.

  • :limit_payment_all (Integer) —

    POS operations limit from beginning. No default value.

  • :payment_daily_limit (Float) —

    POS operations limit for a single day including cents. The decimal delimiter must be &quot;.&quot;. No default value.

  • :pin (String) —

    Card&#39;s PIN code value. Default random PIN.

  • :anonymous (Integer) —

    Card is anonymous. If value is 1 there will be no embossed name.

  • :send_to_parent (Integer) —

    If you put the value 1 the delivery address will be the parent user&#39;s.

  • :mcc_restriction_group_id (Integer) —

    mccRestrictionGroupId you want to apply

  • :merchant_restriction_group_id (Integer) —

    merchantRestrictionGroupId you want to apply

  • :country_restriction_group_id (Integer) —

    countryRestrictionGroupId you want to apply

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

Returns:

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

    InlineResponse2005 data, response status code and response headers



1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
 
# File 'lib/treezor_client/api/card_api.rb', line 1289

def cards_request_physical_post_with_http_info(user_id, wallet_id, perms_group, card_tag, card_print, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CardApi.cards_request_physical_post ...'
  end
  # verify the required parameter 'user_id' is set
  if @api_client.config.client_side_validation && user_id.nil?
    fail ArgumentError, "Missing the required parameter 'user_id' when calling CardApi.cards_request_physical_post"
  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 CardApi.cards_request_physical_post"
  end
  # verify the required parameter 'perms_group' is set
  if @api_client.config.client_side_validation && perms_group.nil?
    fail ArgumentError, "Missing the required parameter 'perms_group' when calling CardApi.cards_request_physical_post"
  end
  # verify the required parameter 'card_tag' is set
  if @api_client.config.client_side_validation && card_tag.nil?
    fail ArgumentError, "Missing the required parameter 'card_tag' when calling CardApi.cards_request_physical_post"
  end
  # verify the required parameter 'card_print' is set
  if @api_client.config.client_side_validation && card_print.nil?
    fail ArgumentError, "Missing the required parameter 'card_print' when calling CardApi.cards_request_physical_post"
  end
  # resource path
  local_var_path = '/cards/RequestPhysical'

  # query parameters
  query_params = {}
  query_params[:'userId'] = user_id
  query_params[:'walletId'] = wallet_id
  query_params[:'permsGroup'] = perms_group
  query_params[:'cardTag'] = card_tag
  query_params[:'cardPrint'] = card_print
  query_params[:'accessSignature'] = opts[:'access_signature'] if !opts[:'access_signature'].nil?
  query_params[:'batchDeliveryId'] = opts[:'batch_delivery_id'] if !opts[:'batch_delivery_id'].nil?
  query_params[:'limitAtmYear'] = opts[:'limit_atm_year'] if !opts[:'limit_atm_year'].nil?
  query_params[:'limitAtmMonth'] = opts[:'limit_atm_month'] if !opts[:'limit_atm_month'].nil?
  query_params[:'limitAtmWeek'] = opts[:'limit_atm_week'] if !opts[:'limit_atm_week'].nil?
  query_params[:'limitAtmDay'] = opts[:'limit_atm_day'] if !opts[:'limit_atm_day'].nil?
  query_params[:'limitAtmAll'] = opts[:'limit_atm_all'] if !opts[:'limit_atm_all'].nil?
  query_params[:'limitPaymentYear'] = opts[:'limit_payment_year'] if !opts[:'limit_payment_year'].nil?
  query_params[:'limitPaymentMonth'] = opts[:'limit_payment_month'] if !opts[:'limit_payment_month'].nil?
  query_params[:'limitPaymentWeek'] = opts[:'limit_payment_week'] if !opts[:'limit_payment_week'].nil?
  query_params[:'limitPaymentDay'] = opts[:'limit_payment_day'] if !opts[:'limit_payment_day'].nil?
  query_params[:'limitPaymentAll'] = opts[:'limit_payment_all'] if !opts[:'limit_payment_all'].nil?
  query_params[:'paymentDailyLimit'] = opts[:'payment_daily_limit'] if !opts[:'payment_daily_limit'].nil?
  query_params[:'pin'] = opts[:'pin'] if !opts[:'pin'].nil?
  query_params[:'anonymous'] = opts[:'anonymous'] if !opts[:'anonymous'].nil?
  query_params[:'sendToParent'] = opts[:'send_to_parent'] if !opts[:'send_to_parent'].nil?
  query_params[:'mccRestrictionGroupId'] = opts[:'mcc_restriction_group_id'] if !opts[:'mcc_restriction_group_id'].nil?
  query_params[:'merchantRestrictionGroupId'] = opts[:'merchant_restriction_group_id'] if !opts[:'merchant_restriction_group_id'].nil?
  query_params[:'countryRestrictionGroupId'] = opts[:'country_restriction_group_id'] if !opts[:'country_restriction_group_id'].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?

  # header parameters
  header_params = {}

  # 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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CardApi#cards_request_physical_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end