lib/plaid/api/plaid_api.rb
# Cancel a transfer
# Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer.  A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
# @param transfer_cancel_request [TransferCancelRequest] 
# @param [Hash] opts the optional parameters
# @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
Cancel a transfer
Use the `/transfer/cancel` endpoint to cancel a transfer.
Cancel a transfer Use the ` / transfer / cancel ` endpoint to cancel a transfer .
def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
      end
      if @api_client.config.client_side_validation && transfer_cancel_request.nil?
        fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
      end
      local_var_path = '/transfer/cancel'
      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(transfer_cancel_request)
      return_type = opts[:debug_return_type] || 'TransferCancelResponse'
      auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
      new_options = opts.merge(
        :operation => :"PlaidApi.transfer_cancel",
        :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#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def transfer_cancel_with_http_info ( transfer_cancel_request , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PlaidApi.transfer_cancel ...' end if @api_client . config . client_side_validation && transfer_cancel_request . nil? fail ArgumentError , "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel" end local_var_path = '/transfer/cancel' 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 ( transfer_cancel_request ) return_type = opts [ :debug_return_type ] || 'TransferCancelResponse' auth_names = opts [ :debug_auth_names ] || [ 'clientId' , 'plaidVersion' , 'secret' ] new_options = opts . merge ( :operation => :" PlaidApi.transfer_cancel " , :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#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Cancel a transfer
Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer.
Cancel a transfer Use the &#x60 ; / transfer / cancel&#x60 ; endpoint to cancel a transfer .
# verify the required parameter 'transfer_cancel_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
TransferCancelResponse data, response status code and response headers
TransferCancelResponse data response status code and response headers
Array<(TransferCancelResponse, Integer, Hash)>
transfer_cancel_request
opts
None
opts the optional parameters
opts the optional parameters