class Bitpesa::AccountDebitsApi
Attributes
Public Class Methods
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Fetching an account debit Returns a single account debit by the account debit ID @param account_debit_id ID of the account debit to get. Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d` @param [Hash] opts the optional parameters @return [DebitResponse]
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 29 def get_accounts_debit(account_debit_id, opts = {}) data, _status_code, _headers = get_accounts_debit_with_http_info(account_debit_id, opts) data end
Fetching an account debit Returns a single account debit by the account debit ID @param account_debit_id ID of the account debit to get. Example: `/v1/accounts/debits/9170c890-1a45-46bd-9b79-3deeb8b4ff3d` @param [Hash] opts the optional parameters @return [Array<(DebitResponse
, Fixnum, Hash)>] DebitResponse
data, response status code and response headers
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 39 def get_accounts_debit_with_http_info(account_debit_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debit ...' end # verify the required parameter 'account_debit_id' is set if @api_client.config.client_side_validation && account_debit_id.nil? fail ArgumentError, "Missing the required parameter 'account_debit_id' when calling AccountDebitsApi.get_accounts_debit" end # resource path local_var_path = '/accounts/debits/{Account Debit ID}'.sub('{' + 'Account Debit ID' + '}', account_debit_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature'] 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 => 'DebitResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Listing Accounts debits Get a list of accounts debits @param [Hash] opts the optional parameters @option opts [Integer] :page The page number to request (defaults to 1) @option opts [Integer] :per The number of results to load per page (defaults to 10) @return [DebitListResponse]
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 84 def get_accounts_debits(opts = {}) data, _status_code, _headers = get_accounts_debits_with_http_info(opts) data end
Listing Accounts debits Get a list of accounts debits @param [Hash] opts the optional parameters @option opts [Integer] :page The page number to request (defaults to 1) @option opts [Integer] :per The number of results to load per page (defaults to 10) @return [Array<(DebitListResponse
, Fixnum, Hash)>] DebitListResponse
data, response status code and response headers
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 95 def get_accounts_debits_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountDebitsApi.get_accounts_debits ...' end # resource path local_var_path = '/accounts/debits' # query parameters query_params = {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per'] = opts[:'per'] if !opts[:'per'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature'] 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 => 'DebitListResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountDebitsApi#get_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Creating an account debit Creates a new account debit finding transaction through the internal balance To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet Once the transaction is funded, we will immediately start trying to pay out the recipient(s). It is also possible to create multiple account debits by supplying an array of debit objects @param debit_request_wrapper @param [Hash] opts the optional parameters @return [DebitListResponse]
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 137 def post_accounts_debits(debit_request_wrapper, opts = {}) data, _status_code, _headers = post_accounts_debits_with_http_info(debit_request_wrapper, opts) data end
Creating an account debit Creates a new account debit finding transaction through the internal balance To successfully fund a transaction - - The currency needs to be the same as the input_currency on the transaction - The amount has to be the same as the input_amount on the transaction - The to_id is the id of the transaction - You need to have enough balance of the appropriate currency inside your wallet Once the transaction is funded, we will immediately start trying to pay out the recipient(s). It is also possible to create multiple account debits by supplying an array of debit objects @param debit_request_wrapper @param [Hash] opts the optional parameters @return [Array<(DebitListResponse
, Fixnum, Hash)>] DebitListResponse
data, response status code and response headers
# File lib/bitpesa-sdk/api/account_debits_api.rb, line 147 def post_accounts_debits_with_http_info(debit_request_wrapper, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: AccountDebitsApi.post_accounts_debits ...' end # verify the required parameter 'debit_request_wrapper' is set if @api_client.config.client_side_validation && debit_request_wrapper.nil? fail ArgumentError, "Missing the required parameter 'debit_request_wrapper' when calling AccountDebitsApi.post_accounts_debits" end # resource path local_var_path = '/accounts/debits' # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(debit_request_wrapper) auth_names = ['AuthorizationKey', 'AuthorizationNonce', 'AuthorizationSecret', 'AuthorizationSignature'] 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 => 'DebitListResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: AccountDebitsApi#post_accounts_debits\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end