class VeloPayments::GetPayoutApi
Attributes
api_client[RW]
Public Class Methods
new(api_client = ApiClient.default)
click to toggle source
# File lib/velopayments/api/get_payout_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
v3_payouts_payout_id_get(payout_id, opts = {})
click to toggle source
Get Payout Summary Get payout summary - returns the current state of the payout. @param payout_id [String] Id of the payout @param [Hash] opts the optional parameters @return [PayoutSummaryResponse]
# File lib/velopayments/api/get_payout_api.rb, line 27 def v3_payouts_payout_id_get(payout_id, opts = {}) data, _status_code, _headers = v3_payouts_payout_id_get_with_http_info(payout_id, opts) data end
v3_payouts_payout_id_get_with_http_info(payout_id, opts = {})
click to toggle source
Get Payout Summary Get payout summary - returns the current state of the payout. @param payout_id [String] Id of the payout @param [Hash] opts the optional parameters @return [Array<(PayoutSummaryResponse
, Integer, Hash)>] PayoutSummaryResponse
data, response status code and response headers
# File lib/velopayments/api/get_payout_api.rb, line 37 def v3_payouts_payout_id_get_with_http_info(payout_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GetPayoutApi.v3_payouts_payout_id_get ...' end # verify the required parameter 'payout_id' is set if @api_client.config.client_side_validation && payout_id.nil? fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.v3_payouts_payout_id_get" end # resource path local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s)) # 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']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PayoutSummaryResponse' # auth_names auth_names = opts[:auth_names] || ['OAuth2'] new_options = opts.merge( :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(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: GetPayoutApi#v3_payouts_payout_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end