class VeloPayments::SubmitPayoutApi
Attributes
Public Class Methods
# File lib/velopayments/api/submit_payout_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Submit Payout <p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>NOTE: amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p> with no decimal places. @param create_payout_request [CreatePayoutRequest] Post amount to transfer using stored funding account details. @param [Hash] opts the optional parameters @return [nil]
# File lib/velopayments/api/submit_payout_api.rb, line 27 def submit_payout(create_payout_request, opts = {}) submit_payout_with_http_info(create_payout_request, opts) nil end
Submit Payout <p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>NOTE: amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p> with no decimal places. @param create_payout_request [CreatePayoutRequest] Post amount to transfer using stored funding account details. @param [Hash] opts the optional parameters @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
# File lib/velopayments/api/submit_payout_api.rb, line 37 def submit_payout_with_http_info(create_payout_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: SubmitPayoutApi.submit_payout ...' end # verify the required parameter 'create_payout_request' is set if @api_client.config.client_side_validation && create_payout_request.nil? fail ArgumentError, "Missing the required parameter 'create_payout_request' when calling SubmitPayoutApi.submit_payout" end # resource path local_var_path = '/v3/payouts' # 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', 'multipart/form-data']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(create_payout_request) # return_type return_type = opts[:return_type] # 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(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: SubmitPayoutApi#submit_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end