class VeloPayments::PayoutHistoryApi
Attributes
Public Class Methods
# File lib/velopayments/api/payout_history_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Get Payments for Payout Get List of payments for Payout @param payout_id [String] The id (UUID) of the payout. @param [Hash] opts the optional parameters @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd. @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd. @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [GetPaymentsForPayoutResponseV3]
# File lib/velopayments/api/payout_history_api.rb, line 39 def get_payments_for_payout(payout_id, opts = {}) data, _status_code, _headers = get_payments_for_payout_with_http_info(payout_id, opts) data end
Get Payments for Payout Get List of payments for Payout, allowing for RETURNED status @param payout_id [String] The id (UUID) of the payout. @param [Hash] opts the optional parameters @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd. @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd. @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25) @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [GetPaymentsForPayoutResponseV4]
# File lib/velopayments/api/payout_history_api.rb, line 141 def get_payments_for_payout_v4(payout_id, opts = {}) data, _status_code, _headers = get_payments_for_payout_v4_with_http_info(payout_id, opts) data end
Get Payments for Payout Get List of payments for Payout, allowing for RETURNED status @param payout_id [String] The id (UUID) of the payout. @param [Hash] opts the optional parameters @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd. @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd. @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Array<(GetPaymentsForPayoutResponseV4
, Integer, Hash)>] GetPaymentsForPayoutResponseV4
data, response status code and response headers
# File lib/velopayments/api/payout_history_api.rb, line 163 def get_payments_for_payout_v4_with_http_info(payout_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutHistoryApi.get_payments_for_payout_v4 ...' 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 PayoutHistoryApi.get_payments_for_payout_v4" end allowable_values = ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "RETURNED", "WITHDRAWN"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v4/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil? query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil? query_params[:'paymentAmountFrom'] = opts[:'payment_amount_from'] if !opts[:'payment_amount_from'].nil? query_params[:'paymentAmountTo'] = opts[:'payment_amount_to'] if !opts[:'payment_amount_to'].nil? query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil? query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil? # 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] || 'GetPaymentsForPayoutResponseV4' # 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: PayoutHistoryApi#get_payments_for_payout_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payments for Payout Get List of payments for Payout @param payout_id [String] The id (UUID) of the payout. @param [Hash] opts the optional parameters @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [Integer] :source_amount_from The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom @option opts [Integer] :source_amount_to The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo @option opts [Integer] :payment_amount_from The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom @option opts [Integer] :payment_amount_to The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo @option opts [Date] :submitted_date_from The submitted date from range filter. Format is yyyy-MM-dd. @option opts [Date] :submitted_date_to The submitted date to range filter. Format is yyyy-MM-dd. @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. @option opts [String] :sort List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status @option opts [Boolean] :sensitive Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. @return [Array<(GetPaymentsForPayoutResponseV3
, Integer, Hash)>] GetPaymentsForPayoutResponseV3
data, response status code and response headers
# File lib/velopayments/api/payout_history_api.rb, line 61 def get_payments_for_payout_with_http_info(payout_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutHistoryApi.get_payments_for_payout ...' 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 PayoutHistoryApi.get_payments_for_payout" end allowable_values = ["ACCEPTED", "AWAITING_FUNDS", "FUNDED", "UNFUNDED", "BANK_PAYMENT_REQUESTED", "REJECTED", "ACCEPTED_BY_RAILS", "CONFIRMED", "FAILED", "RETURNED", "WITHDRAWN"] if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status']) fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}" end # resource path local_var_path = '/v3/paymentaudit/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s)) # query parameters query_params = opts[:query_params] || {} query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'sourceAmountFrom'] = opts[:'source_amount_from'] if !opts[:'source_amount_from'].nil? query_params[:'sourceAmountTo'] = opts[:'source_amount_to'] if !opts[:'source_amount_to'].nil? query_params[:'paymentAmountFrom'] = opts[:'payment_amount_from'] if !opts[:'payment_amount_from'].nil? query_params[:'paymentAmountTo'] = opts[:'payment_amount_to'] if !opts[:'payment_amount_to'].nil? query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil? query_params[:'submittedDateTo'] = opts[:'submitted_date_to'] if !opts[:'submitted_date_to'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? query_params[:'sensitive'] = opts[:'sensitive'] if !opts[:'sensitive'].nil? # 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] || 'GetPaymentsForPayoutResponseV3' # 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: PayoutHistoryApi#get_payments_for_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payout Statistics Get payout statistics for a payor. @param [Hash] opts the optional parameters @option opts [String] :payor_id The account owner Payor ID. Required for external users. @return [GetPayoutStatistics]
# File lib/velopayments/api/payout_history_api.rb, line 231 def get_payout_stats_v1(opts = {}) data, _status_code, _headers = get_payout_stats_v1_with_http_info(opts) data end
Get Payout Statistics Get payout statistics for a payor. @param [Hash] opts the optional parameters @option opts [String] :payor_id The account owner Payor ID. Required for external users. @return [Array<(GetPayoutStatistics
, Integer, Hash)>] GetPayoutStatistics
data, response status code and response headers
# File lib/velopayments/api/payout_history_api.rb, line 241 def get_payout_stats_v1_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PayoutHistoryApi.get_payout_stats_v1 ...' end # resource path local_var_path = '/v1/paymentaudit/payoutStatistics' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? # 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] || 'GetPayoutStatistics' # 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: PayoutHistoryApi#get_payout_stats_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end