velopayments 2.19.40.beta1 → 2.26.124.beta1

data/specs/api/payee_invitation_api_spec.rb

@@ -0,0 +1,161 @@
+=begin
+#Velo Payments APIs
+
+### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
+
+The version of the OpenAPI document: 2.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::PayeeInvitationApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayeeInvitationApi' do
+  before do
+    # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
+    @api_instance = VeloPayments::PayeeInvitationApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayeeInvitationApi' do
+    it 'should create an instance of PayeeInvitationApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PayeeInvitationApi)
+    end
+  end
+
+  # unit tests for get_payees_invitation_status_v3
+  # Get Payee Invitation Status
+  # Returns a filtered, paginated list of payees associated with a payor, along with invitation status and grace period end date. 
+  # @param payor_id The account owner Payor ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payee_id The UUID of the payee.
+  # @option opts [InvitationStatus] :invitation_status The invitation status of the payees.
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+  # @return [PagedPayeeInvitationStatusResponse2]
+  describe 'get_payees_invitation_status_v3 test' do
+    it 'should work' do
+      payor_id = ENV['PAYOR']
+      opts = {
+        payee_id: nil, # String | The UUID of the payee.
+        invitation_status: nil, # VeloPayments::InvitationStatus.new, # InvitationStatus | The invitation status of the payees.
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 25 # Integer | Page size. Default is 25. Max allowable is 100.
+      }
+
+      res = @api_instance.get_payees_invitation_status_v3(payor_id, opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:get_payees_invitation_status_v3) 
+    end
+  end
+
+  # unit tests for query_batch_status_v2
+  # Query Batch Status
+  # <p>Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ).</p> <p>Please use V3 instead</p> 
+  # @param batch_id Batch Id
+  # @param [Hash] opts the optional parameters
+  # @return [QueryBatchResponse]
+  describe 'query_batch_status_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for query_batch_status_v3
+  # Query Batch Status
+  # Fetch the status of a specific batch of payees. The batch is fully processed when status is ACCEPTED and pendingCount is 0 ( 200 - OK, 404 - batch not found ). 
+  # @param batch_id Batch Id
+  # @param [Hash] opts the optional parameters
+  # @return [QueryBatchResponse2]
+  describe 'query_batch_status_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for resend_payee_invite_v1
+  # Resend Payee Invite
+  # <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> <p>Deprecated. Please use v3 instead</p> 
+  # @param payee_id The UUID of the payee.
+  # @param invite_payee_request Provide Payor Id in body of request
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'resend_payee_invite_v1 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for resend_payee_invite_v3
+  # Resend Payee Invite
+  # <p>Resend an invite to the Payee The payee must have already been invited by the payor and not yet accepted or declined</p> <p>Any previous invites to the payee by this Payor will be invalidated</p> 
+  # @param payee_id The UUID of the payee.
+  # @param invite_payee_request2 Provide Payor Id in body of request
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'resend_payee_invite_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for v2_create_payee
+  # Initiate Payee Creation
+  # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). 
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreatePayeesRequest] :create_payees_request Post payees to create.
+  # @return [CreatePayeesCSVResponse]
+  describe 'v2_create_payee test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for v3_create_payee
+  # Initiate Payee Creation
+  # Initiate the process of creating 1 to 2000 payees in a batch Use the response location header to query for status (201 - Created, 400 - invalid request body, 409 - if there is a duplicate remote id within the batch / if there is a duplicate email within the batch). 
+  # @param [Hash] opts the optional parameters
+  # @option opts [CreatePayeesRequest2] :create_payees_request2 Post payees to create.
+  # @return [CreatePayeesCSVResponse2]
+  describe 'v3_create_payee test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/specs/api/payees_api_spec.rb

@@ -0,0 +1,186 @@
+=begin
+#Velo Payments APIs
+
+### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
+
+The version of the OpenAPI document: 2.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::PayeesApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PayeesApi' do
+  before do
+    # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
+    @api_instance = VeloPayments::PayeesApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PayeesApi' do
+    it 'should create an instance of PayeesApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PayeesApi)
+    end
+  end
+
+  # unit tests for delete_payee_by_id_v1
+  # Delete Payee by Id
+  # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> <p>Please use V3 instead.</p> 
+  # @param payee_id The UUID of the payee.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_payee_by_id_v1 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for delete_payee_by_id_v3
+  # Delete Payee by Id
+  # <p>This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:</p> <p>* Payee ID is not found</p> <p>* If Payee has not been on-boarded</p> <p>* If Payee is in grace period</p> <p>* If Payee has existing payments</p> 
+  # @param payee_id The UUID of the payee.
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'delete_payee_by_id_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payee_by_id_v1
+  # Get Payee by Id
+  # <p>Get Payee by Id</p> <p>Please use V3 instead.</p> 
+  # @param payee_id The UUID of the payee.
+  # @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 [Payee]
+  describe 'get_payee_by_id_v1 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payee_by_id_v2
+  # Get Payee by Id
+  # <p>Get Payee by Id</p> <p>Please use V3 instead.</p> 
+  # @param payee_id The UUID of the payee.
+  # @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 [PayeeResponseV2]
+  describe 'get_payee_by_id_v2 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payee_by_id_v3
+  # Get Payee by Id
+  # Get Payee by Id
+  # @param payee_id The UUID of the payee.
+  # @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 [PayeeDetailResponse]
+  describe 'get_payee_by_id_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for list_payee_changes_v3
+  # List Payee Changes
+  # Get a paginated response listing payee changes.
+  # @param payor_id The Payor ID to find associated Payees
+  # @param updated_since 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 [PayeeDeltaResponse2]
+  describe 'list_payee_changes_v3 test' do
+    it 'should work' do
+      payor_id = ENV['PAYOR']
+      updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+      opts = {
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+      }
+      res = @api_instance.list_payee_changes_v3(payor_id, updated_since, opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:list_payee_changes_v3) 
+    end
+  end
+
+  # unit tests for payee_details_update_v3
+  # Update Payee Details
+  # <p>Update payee details for the given Payee Id.<p> 
+  # @param payee_id The UUID of the payee.
+  # @param update_payee_details_request Request to update payee details
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'payee_details_update_v3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for v1_payees_payee_id_remote_id_update_post
+  # Update Payee Remote Id
+  # <p>Update the remote Id for the given Payee Id.</p> <p>Please use V3 instead</p> 
+  # @param payee_id The UUID of the payee.
+  # @param update_remote_id_request Request to update payee remote id v1
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'v1_payees_payee_id_remote_id_update_post test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for v3_payees_payee_id_remote_id_update_post
+  # Update Payee Remote Id
+  # <p>Update the remote Id for the given Payee Id.</p> 
+  # @param payee_id The UUID of the payee.
+  # @param update_remote_id_request Request to update payee remote id v3
+  # @param [Hash] opts the optional parameters
+  # @return [nil]
+  describe 'v3_payees_payee_id_remote_id_update_post test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/specs/api/payment_audit_service_api_spec.rb

@@ -0,0 +1,318 @@
+=begin
+#Velo Payments APIs
+
+### Terms and Definitions  Throughout this document and the Velo platform the following terms are used:  * **Payor.** An entity (typically a corporation) which wishes to pay funds to one or more payees via a payout. * **Payee.** The recipient of funds paid out by a payor. * **Payment.** A single transfer of funds from a payor to a payee. * **Payout.** A batch of Payments, typically used by a payor to logically group payments (e.g. by business day). Technically there need be no relationship between the payments in a payout - a single payout can contain payments to multiple payees and/or multiple payments to a single payee. * **Sandbox.** An integration environment provided by Velo Payments which offers a similar API experience to the production environment, but all funding and payment events are simulated, along with many other services such as OFAC sanctions list checking.  ## Overview  The Velo Payments API allows a payor to perform a number of operations. The following is a list of the main capabilities in a natural order of execution:  * Authenticate with the Velo platform * Maintain a collection of payees * Query the payor’s current balance of funds within the platform and perform additional funding * Issue payments to payees * Query the platform for a history of those payments  This document describes the main concepts and APIs required to get up and running with the Velo Payments platform. It is not an exhaustive API reference. For that, please see the separate Velo Payments API Reference.  ## API Considerations  The Velo Payments API is REST based and uses the JSON format for requests and responses.  Most calls are secured using OAuth 2 security and require a valid authentication access token for successful operation. See the Authentication section for details.  Where a dynamic value is required in the examples below, the {token} format is used, suggesting that the caller needs to supply the appropriate value of the token in question (without including the { or } characters).  Where curl examples are given, the –d @filename.json approach is used, indicating that the request body should be placed into a file named filename.json in the current directory. Each of the curl examples in this document should be considered a single line on the command-line, regardless of how they appear in print.  ## Authenticating with the Velo Platform  Once Velo backoffice staff have added your organization as a payor within the Velo platform sandbox, they will create you a payor Id, an API key and an API secret and share these with you in a secure manner.  You will need to use these values to authenticate with the Velo platform in order to gain access to the APIs. The steps to take are explained in the following:  create a string comprising the API key (e.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8) and API secret (e.g. c396b26b-137a-44fd-87f5-34631f8fd529) with a colon between them. E.g. 44a9537d-d55d-4b47-8082-14061c2bcdd8:c396b26b-137a-44fd-87f5-34631f8fd529  base64 encode this string. E.g.: NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  create an HTTP **Authorization** header with the value set to e.g. Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==  perform the Velo authentication REST call using the HTTP header created above e.g. via curl:  ```   curl -X POST \\   -H \"Content-Type: application/json\" \\   -H \"Authorization: Basic NDRhOTUzN2QtZDU1ZC00YjQ3LTgwODItMTQwNjFjMmJjZGQ4OmMzOTZiMjZiLTEzN2EtNDRmZC04N2Y1LTM0NjMxZjhmZDUyOQ==\" \\   'https://api.sandbox.velopayments.com/v1/authenticate?grant_type=client_credentials' ```  If successful, this call will result in a **200** HTTP status code and a response body such as:  ```   {     \"access_token\":\"19f6bafd-93fd-4747-b229-00507bbc991f\",     \"token_type\":\"bearer\",     \"expires_in\":1799,     \"scope\":\"...\"   } ``` ## API access following authentication Following successful authentication, the value of the access_token field in the response (indicated in green above) should then be presented with all subsequent API calls to allow the Velo platform to validate that the caller is authenticated.  This is achieved by setting the HTTP Authorization header with the value set to e.g. Bearer 19f6bafd-93fd-4747-b229-00507bbc991f such as the curl example below:  ```   -H \"Authorization: Bearer 19f6bafd-93fd-4747-b229-00507bbc991f \" ```  If you make other Velo API calls which require authorization but the Authorization header is missing or invalid then you will get a **401** HTTP status response. 
+
+The version of the OpenAPI document: 2.22.122
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for VeloPayments::PaymentAuditServiceApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'PaymentAuditServiceApi' do
+  before do
+    # run before each test
+    if ENV['APITOKEN'] == ""
+      VeloPayments.configure do |config|
+        config.username = ENV['KEY']
+        config.password =  ENV['SECRET']
+      end
+      
+      api_instance = VeloPayments::LoginApi.new
+      opts = {
+        grant_type: 'client_credentials'
+      }
+      
+      begin
+        res = api_instance.velo_auth(opts)
+
+        ENV['APITOKEN'] = res.access_token
+      rescue VeloPayments::ApiError => e
+        puts "Exception when calling LoginApi->velo_auth: #{e}"
+      end
+    end
+
+    uri = URI.parse(ENV['APIURL'])
+    VeloPayments.configure do |config|
+      config.access_token = ENV['APITOKEN']
+      config.host = uri.host
+    end
+
+    @api_instance = VeloPayments::PaymentAuditServiceApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of PaymentAuditServiceApi' do
+    it 'should create an instance of PaymentAuditServiceApi' do
+      expect(@api_instance).to be_instance_of(VeloPayments::PaymentAuditServiceApi)
+    end
+  end
+
+  # unit tests for export_transactions_csvv3
+  # 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]
+  describe 'export_transactions_csvv3 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for export_transactions_csvv4
+  # 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 <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p> 
+  # @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
+  # @option opts [String] :include <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>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.</p> <p>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</p> 
+  # @return [PayorAmlTransactionV4]
+  describe 'export_transactions_csvv4 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_fundings_v4
+  # Get Fundings for Payor
+  # <p>Get a list of Fundings for a payor.</p> 
+  # @param payor_id The account owner Payor ID
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :page Page number. Default is 1.
+  # @option opts [Integer] :page_size The number of results to return in a page
+  # @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]
+  describe 'get_fundings_v4 test' do
+    skip "skipping test" do
+    # it 'should work' do
+    #   payor_id = ENV['PAYOR']
+    #   opts = {
+    #     page: 1, # Integer | Page number. Default is 1.
+    #     page_size: 25, # Integer | The number of results to return in a page
+    #     sort: 'dateTime:desc' # String | List of sort fields. Example: ```?sort=destinationCurrency:asc,destinationAmount:asc``` Default is no sort. The supported sort fields are: dateTime and amount. 
+    #   }
+    #   res = @api_instance.get_fundings_v4(payor_id, opts)
+    #   expect(res.content.length()).to be >= 1
+    #   expect(@api_instance).to respond_to(:get_fundings_v4) 
+    end
+  end
+
+  # unit tests for get_payment_details
+  # Get Payment
+  # Get the payment with the given id. This contains the payment history. 
+  # @param payment_id 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]
+  describe 'get_payment_details test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payment_details_v4
+  # Get Payment
+  # Get the payment with the given id. This contains the payment history. 
+  # @param payment_id 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]
+  describe 'get_payment_details_v4 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payments_for_payout
+  # Get Payments for Payout
+  # Get List of payments for Payout 
+  # @param payout_id 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 The number of results to return in a page
+  # @option opts [String] :sort <p>List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId</p> <p>The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status</p> 
+  # @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]
+  describe 'get_payments_for_payout test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payments_for_payout_v4
+  # Get Payments for Payout
+  # Get List of payments for Payout, allowing for RETURNED status 
+  # @param payout_id 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 The number of results to return in a page
+  # @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]
+  describe 'get_payments_for_payout_v4 test' do
+    skip "skipping test" do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for get_payout_stats_v4
+  # Get Payout Statistics
+  # <p>Get payout statistics for a payor.</p> 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :payor_id The account owner Payor ID. Required for external users.
+  # @return [GetPayoutStatistics]
+  describe 'get_payout_stats_v4 test' do
+    it 'should work' do
+      opts = {
+        payor_id: ENV['PAYOR']
+      }
+      res = @api_instance.get_payout_stats_v4(opts)
+      expect(res.this_month_payouts_count).to be >= 1
+      expect(@api_instance).to respond_to(:get_payout_stats_v4) 
+    end
+  end
+
+  # unit tests for get_payouts_for_payor_v4
+  # 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 The number of results to return in a page
+  # @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]
+  describe 'get_payouts_for_payor_v4 test' do
+    it 'should work' do
+      opts = {
+        payor_id: ENV['PAYOR'], # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
+        payout_memo: nil, # # String | Payout Memo filter - case insensitive sub-string match
+        status: nil, # String | Payout Status
+        submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+        submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+        from_payor_name: nil, # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 25, # Integer | The number of results to return in a page
+        sort: 'submittedDateTime:desc' # String | 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 
+      }
+
+      res = @api_instance.get_payouts_for_payor_v4(opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:get_payouts_for_payor_v4) 
+    end
+  end
+
+  # unit tests for list_payment_changes_v4
+  # List Payment Changes
+  # Get a paginated response listing payment changes.
+  # @param payor_id The Payor ID to find associated Payments
+  # @param updated_since 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 The number of results to return in a page
+  # @return [PaymentDeltaResponseV4]
+  describe 'list_payment_changes_v4 test' do
+    skip "skipping broken test" do
+    # it 'should work' do
+    #   payor_id = ENV['PAYOR'] # String | The Payor ID to find associated Payments
+    #   updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+    #   opts = {
+    #     page: 1, # Integer | Page number. Default is 1.
+    #     page_size: 100 # Integer | The number of results to return in a page
+    #   }
+
+    #   res = @api_instance.list_payment_changes_v4(payor_id, updated_since, opts)
+    #   expect(res.content.length()).to be >= 1
+    #   expect(@api_instance).to respond_to(:list_payment_changes_v4) 
+    end
+  end
+
+  # unit tests for list_payments_audit_v4
+  # 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 The number of results to return in a page
+  # @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]
+  describe 'list_payments_audit_v4 test' do
+    it 'should work' do
+      opts = {
+        payee_id: nil, # String | The UUID of the payee.
+        payor_id: ENV['PAYOR'], # String | The account owner Payor Id. Required for external users.
+        payor_name: nil, # String | The payor’s name. This filters via a case insensitive substring match.
+        remote_id: nil, # String | The remote id of the payees.
+        status: nil, # String | Payment Status
+        source_account_name: nil, # String | The source account name filter. This filters via a case insensitive substring match.
+        source_amount_from: nil, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
+        source_amount_to: nil, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
+        source_currency: nil, # String | The source currency filter. Filters based on an exact match on the currency.
+        payment_amount_from: nil, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
+        payment_amount_to: nil, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
+        payment_currency: nil, # String | The payment currency filter. Filters based on an exact match on the currency.
+        submitted_date_from: nil, # Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+        submitted_date_to: nil, # Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+        payment_memo: nil, # String | The payment memo filter. This filters via a case insensitive substring match.
+        page: 1, # Integer | Page number. Default is 1.
+        page_size: 25, # Integer | The number of results to return in a page
+        sort: 'submittedDateTime:desc', # String | 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 
+        sensitive: true # Boolean | 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. 
+      }
+
+      res = @api_instance.list_payments_audit_v4(opts)
+      expect(res.content.length()).to be >= 1
+      expect(@api_instance).to respond_to(:list_payments_audit_v4) 
+    end
+  end
+
+end