class VeloPayments::PaymentAuditServiceApi
Attributes
Public Class Methods
# File lib/velopayments/api/payment_audit_service_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Export Transactions Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. @param [Hash] opts the optional parameters @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD @return [PayorAmlTransactionV3]
# File lib/velopayments/api/payment_audit_service_api.rb, line 29 def export_transactions_csvv3(opts = {}) data, _status_code, _headers = export_transactions_csvv3_with_http_info(opts) data end
Export Transactions Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. @param [Hash] opts the optional parameters @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD @option opts [Date] :end_date End date, inclusive. Format is YYYY-MM-DD @return [Array<(PayorAmlTransactionV3
, Integer, Hash)>] PayorAmlTransactionV3
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 41 def export_transactions_csvv3_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv3 ...' end # resource path local_var_path = '/v3/paymentaudit/transactions' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil? query_params[:'endDate'] = opts[:'end_date'] if !opts[:'end_date'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/csv']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PayorAmlTransactionV3' # 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: PaymentAuditServiceApi#export_transactions_csvv3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Export Transactions Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. @param [Hash] opts the optional parameters @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD @option opts [Date] :submitted_date_from Start date, inclusive. Format is YYYY-MM-DD @option opts [String] :include Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor. Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id @return [PayorAmlTransactionV4]
# File lib/velopayments/api/payment_audit_service_api.rb, line 95 def export_transactions_csvv4(opts = {}) data, _status_code, _headers = export_transactions_csvv4_with_http_info(opts) data end
Export Transactions Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates. @param [Hash] opts the optional parameters @option opts [String] :payor_id The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. @option opts [Date] :start_date Start date, inclusive. Format is YYYY-MM-DD @option opts [Date] :submitted_date_from Start date, inclusive. Format is YYYY-MM-DD @option opts [String] :include Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor. Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id @return [Array<(PayorAmlTransactionV4
, Integer, Hash)>] PayorAmlTransactionV4
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 108 def export_transactions_csvv4_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.export_transactions_csvv4 ...' end allowable_values = ["payorOnly", "payorAndDescendants"] if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include']) fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}" end # resource path local_var_path = '/v4/paymentaudit/transactions' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? query_params[:'startDate'] = opts[:'start_date'] if !opts[:'start_date'].nil? query_params[:'submittedDateFrom'] = opts[:'submitted_date_from'] if !opts[:'submitted_date_from'].nil? query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/csv']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PayorAmlTransactionV4' # 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: PaymentAuditServiceApi#export_transactions_csvv4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Fundings for Payor Get a list of Fundings for a payor. @param [Hash] opts the optional parameters @option opts [String] :payor_id The account owner Payor ID @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. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. @return [GetFundingsResponse]
# File lib/velopayments/api/payment_audit_service_api.rb, line 167 def get_fundings_v1(opts = {}) data, _status_code, _headers = get_fundings_v1_with_http_info(opts) data end
Get Fundings for Payor Get a list of Fundings for a payor. @param [Hash] opts the optional parameters @option opts [String] :payor_id The account owner Payor ID @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. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. @return [Array<(GetFundingsResponse
, Integer, Hash)>] GetFundingsResponse
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 180 def get_fundings_v1_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_fundings_v1 ...' end # resource path local_var_path = '/v1/paymentaudit/fundings' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].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? # 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] || 'GetFundingsResponse' # 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: PaymentAuditServiceApi#get_fundings_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payment Get the payment with the given id. This contains the payment history. @param payment_id [String] Payment Id @param [Hash] opts the optional parameters @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 [PaymentResponseV3]
# File lib/velopayments/api/payment_audit_service_api.rb, line 233 def get_payment_details(payment_id, opts = {}) data, _status_code, _headers = get_payment_details_with_http_info(payment_id, opts) data end
Get Payment Get the payment with the given id. This contains the payment history. @param payment_id [String] Payment Id @param [Hash] opts the optional parameters @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 [PaymentResponseV4]
# File lib/velopayments/api/payment_audit_service_api.rb, line 298 def get_payment_details_v4(payment_id, opts = {}) data, _status_code, _headers = get_payment_details_v4_with_http_info(payment_id, opts) data end
Get Payment Get the payment with the given id. This contains the payment history. @param payment_id [String] Payment Id @param [Hash] opts the optional parameters @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<(PaymentResponseV4
, Integer, Hash)>] PaymentResponseV4
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 309 def get_payment_details_v4_with_http_info(payment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payment_details_v4 ...' end # verify the required parameter 'payment_id' is set if @api_client.config.client_side_validation && payment_id.nil? fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentAuditServiceApi.get_payment_details_v4" end # resource path local_var_path = '/v4/paymentaudit/payments/{paymentId}'.sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s)) # query parameters query_params = opts[:query_params] || {} 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] || 'PaymentResponseV4' # 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: PaymentAuditServiceApi#get_payment_details_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payment Get the payment with the given id. This contains the payment history. @param payment_id [String] Payment Id @param [Hash] opts the optional parameters @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<(PaymentResponseV3
, Integer, Hash)>] PaymentResponseV3
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 244 def get_payment_details_with_http_info(payment_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payment_details ...' end # verify the required parameter 'payment_id' is set if @api_client.config.client_side_validation && payment_id.nil? fail ArgumentError, "Missing the required parameter 'payment_id' when calling PaymentAuditServiceApi.get_payment_details" end # resource path local_var_path = '/v3/paymentaudit/payments/{paymentId}'.sub('{' + 'paymentId' + '}', CGI.escape(payment_id.to_s)) # query parameters query_params = opts[:query_params] || {} 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] || 'PaymentResponseV3' # 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: PaymentAuditServiceApi#get_payment_details\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. (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/payment_audit_service_api.rb, line 374 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/payment_audit_service_api.rb, line 476 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/payment_audit_service_api.rb, line 498 def get_payments_for_payout_v4_with_http_info(payout_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.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 PaymentAuditServiceApi.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: PaymentAuditServiceApi#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/payment_audit_service_api.rb, line 396 def get_payments_for_payout_with_http_info(payout_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.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 PaymentAuditServiceApi.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: PaymentAuditServiceApi#get_payments_for_payout\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payouts for Payor Get List of payouts for payor @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match @option opts [String] :status Payout Status @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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. @return [GetPayoutsResponseV3]
# File lib/velopayments/api/payment_audit_service_api.rb, line 573 def get_payouts_for_payor_v3(payor_id, opts = {}) data, _status_code, _headers = get_payouts_for_payor_v3_with_http_info(payor_id, opts) data end
Get Payouts for Payor Get List of payouts for payor @param payor_id [String] The account owner Payor ID @param [Hash] opts the optional parameters @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match @option opts [String] :status Payout Status @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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. @return [Array<(GetPayoutsResponseV3
, Integer, Hash)>] GetPayoutsResponseV3
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 590 def get_payouts_for_payor_v3_with_http_info(payor_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payouts_for_payor_v3 ...' end # verify the required parameter 'payor_id' is set if @api_client.config.client_side_validation && payor_id.nil? fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.get_payouts_for_payor_v3" end allowable_values = ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "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' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = payor_id query_params[:'payoutMemo'] = opts[:'payout_memo'] if !opts[:'payout_memo'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].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? # 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] || 'GetPayoutsResponseV3' # 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: PaymentAuditServiceApi#get_payouts_for_payor_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get Payouts for Payor Get List of payouts for payor @param [Hash] opts the optional parameters @option opts [String] :payor_id The id (UUID) of the payor funding the payout or the payor whose payees are being paid. @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match @option opts [String] :status Payout Status @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 [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match. @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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId @return [GetPayoutsResponseV4]
# File lib/velopayments/api/payment_audit_service_api.rb, line 662 def get_payouts_for_payor_v4(opts = {}) data, _status_code, _headers = get_payouts_for_payor_v4_with_http_info(opts) data end
Get Payouts for Payor Get List of payouts for payor @param [Hash] opts the optional parameters @option opts [String] :payor_id The id (UUID) of the payor funding the payout or the payor whose payees are being paid. @option opts [String] :payout_memo Payout Memo filter - case insensitive sub-string match @option opts [String] :status Payout Status @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 [String] :from_payor_name The name of the payor whose payees are being paid. This filters via a case insensitive substring match. @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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId @return [Array<(GetPayoutsResponseV4
, Integer, Hash)>] GetPayoutsResponseV4
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 680 def get_payouts_for_payor_v4_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.get_payouts_for_payor_v4 ...' end allowable_values = ["ACCEPTED", "REJECTED", "SUBMITTED", "QUOTED", "INSTRUCTED", "COMPLETED", "INCOMPLETE", "CONFIRMED", "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' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? query_params[:'payoutMemo'] = opts[:'payout_memo'] if !opts[:'payout_memo'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].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[:'fromPayorName'] = opts[:'from_payor_name'] if !opts[:'from_payor_name'].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? # 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] || 'GetPayoutsResponseV4' # 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: PaymentAuditServiceApi#get_payouts_for_payor_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
List Payment Changes Get a paginated response listing payment changes. @param payor_id [String] The Payor ID to find associated Payments @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. (default to 1) @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. (default to 100) @return [PaymentDeltaResponse]
# File lib/velopayments/api/payment_audit_service_api.rb, line 744 def list_payment_changes(payor_id, updated_since, opts = {}) data, _status_code, _headers = list_payment_changes_with_http_info(payor_id, updated_since, opts) data end
List Payment Changes Get a paginated response listing payment changes. @param payor_id [String] The Payor ID to find associated Payments @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm @param [Hash] opts the optional parameters @option opts [Integer] :page Page number. Default is 1. @option opts [Integer] :page_size Page size. Default is 100. Max allowable is 1000. @return [Array<(PaymentDeltaResponse
, Integer, Hash)>] PaymentDeltaResponse
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 757 def list_payment_changes_with_http_info(payor_id, updated_since, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payment_changes ...' end # verify the required parameter 'payor_id' is set if @api_client.config.client_side_validation && payor_id.nil? fail ArgumentError, "Missing the required parameter 'payor_id' when calling PaymentAuditServiceApi.list_payment_changes" end # verify the required parameter 'updated_since' is set if @api_client.config.client_side_validation && updated_since.nil? fail ArgumentError, "Missing the required parameter 'updated_since' when calling PaymentAuditServiceApi.list_payment_changes" end # resource path local_var_path = '/v1/deltas/payments' # query parameters query_params = opts[:query_params] || {} query_params[:'payorId'] = payor_id query_params[:'updatedSince'] = updated_since query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].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] || 'PaymentDeltaResponse' # 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: PaymentAuditServiceApi#list_payment_changes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get List of Payments Get payments for the given payor Id @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [String] :payor_id The account owner Payor Id. Required for external users. @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match. @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match. @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 [String] :source_currency The source currency filter. Filters based on an exact match on the currency. @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 [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency. @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 [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match. @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 [ListPaymentsResponse]
# File lib/velopayments/api/payment_audit_service_api.rb, line 835 def list_payments_audit(opts = {}) data, _status_code, _headers = list_payments_audit_with_http_info(opts) data end
Get List of Payments Get payments for the given payor Id @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [String] :payor_id The account owner Payor Id. Required for external users. @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match. @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match. @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 [String] :source_currency The source currency filter. Filters based on an exact match on the currency. @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 [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency. @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 [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match. @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 submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId @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 [ListPaymentsResponseV4]
# File lib/velopayments/api/payment_audit_service_api.rb, line 952 def list_payments_audit_v4(opts = {}) data, _status_code, _headers = list_payments_audit_v4_with_http_info(opts) data end
Get List of Payments Get payments for the given payor Id @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [String] :payor_id The account owner Payor Id. Required for external users. @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match. @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match. @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 [String] :source_currency The source currency filter. Filters based on an exact match on the currency. @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 [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency. @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 [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match. @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 submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId @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<(ListPaymentsResponseV4
, Integer, Hash)>] ListPaymentsResponseV4
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 980 def list_payments_audit_v4_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payments_audit_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/payments' # query parameters query_params = opts[:query_params] || {} query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil? query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? query_params[:'payorName'] = opts[:'payor_name'] if !opts[:'payor_name'].nil? query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].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[:'sourceCurrency'] = opts[:'source_currency'] if !opts[:'source_currency'].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[:'paymentCurrency'] = opts[:'payment_currency'] if !opts[:'payment_currency'].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[:'paymentMemo'] = opts[:'payment_memo'] if !opts[:'payment_memo'].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] || 'ListPaymentsResponseV4' # 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: PaymentAuditServiceApi#list_payments_audit_v4\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get List of Payments Get payments for the given payor Id @param [Hash] opts the optional parameters @option opts [String] :payee_id The UUID of the payee. @option opts [String] :payor_id The account owner Payor Id. Required for external users. @option opts [String] :payor_name The payor’s name. This filters via a case insensitive substring match. @option opts [String] :remote_id The remote id of the payees. @option opts [String] :status Payment Status @option opts [String] :source_account_name The source account name filter. This filters via a case insensitive substring match. @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 [String] :source_currency The source currency filter. Filters based on an exact match on the currency. @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 [String] :payment_currency The payment currency filter. Filters based on an exact match on the currency. @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 [String] :payment_memo The payment memo filter. This filters via a case insensitive substring match. @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<(ListPaymentsResponse
, Integer, Hash)>] ListPaymentsResponse
data, response status code and response headers
# File lib/velopayments/api/payment_audit_service_api.rb, line 863 def list_payments_audit_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: PaymentAuditServiceApi.list_payments_audit ...' 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/payments' # query parameters query_params = opts[:query_params] || {} query_params[:'payeeId'] = opts[:'payee_id'] if !opts[:'payee_id'].nil? query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil? query_params[:'payorName'] = opts[:'payor_name'] if !opts[:'payor_name'].nil? query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil? query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil? query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].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[:'sourceCurrency'] = opts[:'source_currency'] if !opts[:'source_currency'].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[:'paymentCurrency'] = opts[:'payment_currency'] if !opts[:'payment_currency'].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[:'paymentMemo'] = opts[:'payment_memo'] if !opts[:'payment_memo'].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] || 'ListPaymentsResponse' # 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: PaymentAuditServiceApi#list_payments_audit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end