lib/velopayments/api/payout_service_api.rb
# Withdraw Payout
# Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
# @param payout_id [String] Id of the payout
# @param [Hash] opts the optional parameters
# @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
Withdraw Payout
Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
Withdraw Payout Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit .
def withdraw_payout_v3_with_http_info(payout_id, opts = {})
      if @api_client.config.debugging
        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.withdraw_payout_v3 ...'
      end
      if @api_client.config.client_side_validation && payout_id.nil?
        fail ArgumentError, "Missing the required parameter 'payout_id' when calling PayoutServiceApi.withdraw_payout_v3"
      end
      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
      query_params = opts[:query_params] || {}
      header_params = opts[:header_params] || {}
      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
      form_params = opts[:form_params] || {}
      post_body = opts[:debug_body]
      return_type = opts[:debug_return_type]
      auth_names = opts[:debug_auth_names] || ['OAuth2']
      new_options = opts.merge(
        :operation => :"PayoutServiceApi.withdraw_payout_v3",
        :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(:DELETE, local_var_path, new_options)
      if @api_client.config.debugging
        @api_client.config.logger.debug "API called: PayoutServiceApi#withdraw_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
      end
      return data, status_code, headers
    end
def withdraw_payout_v3_with_http_info ( payout_id , opts = { } ) if @api_client . config . debugging @api_client . config . logger . debug 'Calling API: PayoutServiceApi.withdraw_payout_v3 ...' end if @api_client . config . client_side_validation && payout_id . nil? fail ArgumentError , "Missing the required parameter 'payout_id' when calling PayoutServiceApi.withdraw_payout_v3" end local_var_path = '/v3/payouts/{payoutId}' . sub ( '{' + 'payoutId' + '}' , CGI . escape ( payout_id . to_s ) ) query_params = opts [ :query_params ] || { } header_params = opts [ :header_params ] || { } header_params [ 'Accept' ] = @api_client . select_header_accept ( [ 'application/json' ] ) form_params = opts [ :form_params ] || { } post_body = opts [ :debug_body ] return_type = opts [ :debug_return_type ] auth_names = opts [ :debug_auth_names ] || [ 'OAuth2' ] new_options = opts . merge ( :operation => :" PayoutServiceApi.withdraw_payout_v3 " , :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 ( :DELETE , local_var_path , new_options ) if @api_client . config . debugging @api_client . config . logger . debug "API called: PayoutServiceApi#withdraw_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data , status_code , headers end
Withdraw Payout
Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
Withdraw Payout Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit .
# verify the required parameter 'payout_id' is set # resource path # query parameters # header parameters # HTTP header 'Accept' (if needed) # form parameters # http body (model) # return_type # auth_names
nil, response status code and response headers
nil response status code and response headers
Array<(nil, Integer, Hash)>
payout_id
Id of the payout
Id of the payout
opts
<not_specific>
<not_specific>
opts the optional parameters
opts the optional parameters