lib/plaid/api/plaid_api.rb
def processor_balance_get_with_http_info(processor_balance_get_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.processor_balance_get ...'
      end
      # verify the required parameter 'processor_balance_get_request' is set
      if @api_client.config.client_side_validation && processor_balance_get_request.nil?
        fail ArgumentError, "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get"
      end
      # resource path
      local_var_path = '/processor/balance/get'

      # query parameters
      query_params = opts[:query_params] || {}

      # header parameters
      header_params = opts[: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 = opts[:form_params] || {}

      # http body (model)
      post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_balance_get_request)

      # return_type
      return_type = opts[:debug_return_type] || 'ProcessorBalanceGetResponse'

      # auth_names
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']

      new_options = opts.merge(
        :operation => :"PlaidApi.processor_balance_get",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )

      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
# Retrieve Balance data
# The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts. While other endpoints may return a balance object, only &#x60;/processor/balance/get&#x60; forces the available and current balance fields to be refreshed rather than cached. 
# @param processor_balance_get_request [ProcessorBalanceGetRequest] The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;.  The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account.  Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of &#x60;null&#x60;.
# @param [Hash] opts the optional parameters
# @return [Array<(ProcessorBalanceGetResponse, Integer, Hash)>] ProcessorBalanceGetResponse data, response status code and response headers
Retrieve Balance data
The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
Retrieve Balance data The ` / processor / balance / get ` endpoint returns the real - time balance for each of an Item ' s accounts . While other endpoints may return a balance object only ` / processor / balance / get ` forces the available and current balance fields to be refreshed rather than cached .
def processor_balance_get_with_http_info(processor_balance_get_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.processor_balance_get ...'
      end
      if @api_client.config.client_side_validation && processor_balance_get_request.nil?
        fail ArgumentError, "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get"
      end
      local_var_path = '/processor/balance/get'
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_balance_get_request)
      return_type = opts[:debug_return_type] || 'ProcessorBalanceGetResponse'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.processor_balance_get",
        :header_params => header_params,
        :query_params => query_params,
        :form_params => form_params,
        :body => post_body,
        :auth_names => auth_names,
        :return_type => return_type
      )
      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def processor_balance_get_with_http_info ( processor_balance_get_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.processor_balance_get ...' end if @api_client . config . client_side_validation && processor_balance_get_request . nil? fail ArgumentError , "Missing the required parameter 'processor_balance_get_request' when calling PlaidApi.processor_balance_get" end local_var_path = '/processor/balance/get' query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) header_params [ 'Content-Type' ] = @api_client . select_header_content_type ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] || @api_client . object_to_http_body ( processor_balance_get_request ) return_type = opts [ :debug_return_type ] || 'ProcessorBalanceGetResponse' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.processor_balance_get " , :header_params => header_params , :query_params => query_params , :form_params => form_params , :body => post_body , :auth_names => auth_names , :return_type => return_type ) data , status_code , headers = @api_client . call_api ( :POST , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: PlaidApi#processor_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Retrieve Balance data
The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts.
Retrieve Balance data The &#x60 ; / processor / balance / get&#x60 ; endpoint returns the real - time balance for each of an Item&#39 ; s accounts .
# verify the required parameter 'processor_balance_get_request' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # HTTP header 'Content-Type' # form parameters # http body (model) # return_type # auth_names
ProcessorBalanceGetResponse data, response status code and response headers
ProcessorBalanceGetResponse data response status code and response headers
Array<(ProcessorBalanceGetResponse, Integer, Hash)>
processor_balance_get_request
The `/processor/balance/get` endpoint returns the real-time balance for the account associated with a given `processor_token`. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of `null`.
The ` / processor / balance / get ` endpoint returns the real - time balance for the account associated with a given ` processor_token ` . The current balance is the total amount of funds in the account . The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account . Note that not all institutions calculate the available balance . In the event that available balance is unavailable from the institution Plaid will return an available balance value of ` null ` .
opts
opts the optional parameters
opts the optional parameters