Class: ZipMoney::TokensApi

Inherits:
Object
  • Object
show all
Defined in:
lib/zip_money/api/tokens_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TokensApi 



12
13
14
 
# File 'lib/zip_money/api/tokens_api.rb', line 12

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



10
11
12
 
# File 'lib/zip_money/api/tokens_api.rb', line 10

def api_client
  @api_client
end

Instance Method Details

#tokens_create(opts = {}) ⇒ Token

Create token Tokenises a zip account allowing a charge to be performed at a later date without direct customer involvement. In order to create a token you will first need to request customer approval by implementing one of the online checkout flows. The checkout id will then be provided as the authority when tokenising. | Error code | Description | |————————————|————————————————————————————————–| | account_inoperative | The account is in arrears or closed and cannot be charged | | account_locked | The account is locked |

Options Hash (opts):



22
23
24
25
 
# File 'lib/zip_money/api/tokens_api.rb', line 22

def tokens_create(opts = {})
  data, _status_code, _headers = tokens_create_with_http_info(opts)
  return data
end

#tokens_create_with_http_info(opts = {}) ⇒ Array<(Token, Fixnum, Hash)>

Create token Tokenises a zip account allowing a charge to be performed at a later date without direct customer involvement. In order to create a token you will first need to request customer approval by implementing one of the online checkout flows. The checkout id will then be provided as the authority when tokenising. | Error code | Description | |————————————|————————————————————————————————–| | account_inoperative | The account is in arrears or closed and cannot be charged | | account_locked | The account is locked |

Options Hash (opts):



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/zip_money/api/tokens_api.rb', line 33

def tokens_create_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: TokensApi.tokens_create ..."
  end
  # resource path
  local_var_path = "/tokens".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/javascript'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['Authorization']
  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 => 'Token')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TokensApi#tokens_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end