velopayments 2.14.90.pre.1 → 2.17.8.beta1

data/lib/velopayments/api/get_payout_api.rb

@@ -3,10 +3,10 @@
 
 ### 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.14.92
+The version of the OpenAPI document: 2.17.8
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.1.0-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -43,7 +43,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.v3_payouts_payout_id_get"
       end
       # resource path
-      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/velopayments/api/instruct_payout_api.rb

@@ -3,10 +3,10 @@
 
 ### 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.14.92
+The version of the OpenAPI document: 2.17.8
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.1.0-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -43,7 +43,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payout_id' when calling InstructPayoutApi.v3_payouts_payout_id_post"
       end
       # resource path
-      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}

data/lib/velopayments/api/payee_invitation_api.rb

@@ -3,10 +3,10 @@
 
 ### 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.14.92
+The version of the OpenAPI document: 2.17.8
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.1.0-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -43,7 +43,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status"
       end
       # resource path
-      local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v1/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -113,7 +113,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payor_id' when calling PayeeInvitationApi.get_payees_invitation_status_v2"
       end
       # resource path
-      local_var_path = '/v2/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v2/payees/payors/{payorId}/invitationStatus'.sub('{' + 'payorId' + '}', CGI.escape(payor_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -185,7 +185,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'invite_payee_request' when calling PayeeInvitationApi.resend_payee_invite"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v1/payees/{payeeId}/invite'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -225,7 +225,7 @@ module VeloPayments
       return data, status_code, headers
     end
 
-    # Intiate Payee Creation
+    # Intiate Payee Creation V2
     # 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 create_payees_request [CreatePayeesRequest] Post payees to create.
     # @param [Hash] opts the optional parameters
@@ -235,7 +235,7 @@ module VeloPayments
       data
     end
 
-    # Intiate Payee Creation
+    # Intiate Payee Creation V2
     # 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 create_payees_request [CreatePayeesRequest] Post payees to create.
     # @param [Hash] opts the optional parameters
@@ -313,7 +313,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.v2_query_batch_status"
       end
       # resource path
-      local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v2/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -350,5 +350,131 @@ module VeloPayments
       end
       return data, status_code, headers
     end
+
+    # Intiate Payee Creation V3
+    # 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 create_payees_request2 [CreatePayeesRequest2] Post payees to create.
+    # @param [Hash] opts the optional parameters
+    # @return [CreatePayeesCSVResponse2]
+    def v3_create_payee(create_payees_request2, opts = {})
+      data, _status_code, _headers = v3_create_payee_with_http_info(create_payees_request2, opts)
+      data
+    end
+
+    # Intiate Payee Creation V3
+    # 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 create_payees_request2 [CreatePayeesRequest2] Post payees to create.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(CreatePayeesCSVResponse2, Integer, Hash)>] CreatePayeesCSVResponse2 data, response status code and response headers
+    def v3_create_payee_with_http_info(create_payees_request2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_create_payee ...'
+      end
+      # verify the required parameter 'create_payees_request2' is set
+      if @api_client.config.client_side_validation && create_payees_request2.nil?
+        fail ArgumentError, "Missing the required parameter 'create_payees_request2' when calling PayeeInvitationApi.v3_create_payee"
+      end
+      # resource path
+      local_var_path = '/v3/payees'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'multipart/form-data'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(create_payees_request2) 
+
+      # return_type
+      return_type = opts[:return_type] || 'CreatePayeesCSVResponse2' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeeInvitationApi#v3_create_payee\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 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 [String] Batch Id
+    # @param [Hash] opts the optional parameters
+    # @return [QueryBatchResponse]
+    def v3_query_batch_status(batch_id, opts = {})
+      data, _status_code, _headers = v3_query_batch_status_with_http_info(batch_id, opts)
+      data
+    end
+
+    # 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 [String] Batch Id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(QueryBatchResponse, Integer, Hash)>] QueryBatchResponse data, response status code and response headers
+    def v3_query_batch_status_with_http_info(batch_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeeInvitationApi.v3_query_batch_status ...'
+      end
+      # verify the required parameter 'batch_id' is set
+      if @api_client.config.client_side_validation && batch_id.nil?
+        fail ArgumentError, "Missing the required parameter 'batch_id' when calling PayeeInvitationApi.v3_query_batch_status"
+      end
+      # resource path
+      local_var_path = '/v3/payees/batch/{batchId}'.sub('{' + 'batchId' + '}', CGI.escape(batch_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'QueryBatchResponse' 
+
+      # 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: PayeeInvitationApi#v3_query_batch_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

data/lib/velopayments/api/payees_api.rb

@@ -3,10 +3,10 @@
 
 ### 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.14.92
+The version of the OpenAPI document: 2.17.8
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.1.0-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -43,7 +43,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.delete_payee_by_id"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -105,7 +105,7 @@ module VeloPayments
         fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.get_payee_by_id"
       end
       # resource path
-      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s).gsub('%2F', '/'))
+      local_var_path = '/v1/payees/{payeeId}'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
 
       # query parameters
       query_params = opts[:query_params] || {}
@@ -230,11 +230,11 @@ module VeloPayments
     # @option opts [String] :display_name The display name of the payees.
     # @option opts [String] :remote_id The remote id of the payees.
     # @option opts [PayeeType] :payee_type The onboarded status of the payees.
-    # @option opts [String] :payee_country The country of the payees.
+    # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
     # @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=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.  (default to 'displayName:asc')
-    # @return [PayeeResponse]
+    # @return [PagedPayeeResponse]
     def list_payees(payor_id, opts = {})
       data, _status_code, _headers = list_payees_with_http_info(payor_id, opts)
       data
@@ -250,11 +250,11 @@ module VeloPayments
     # @option opts [String] :display_name The display name of the payees.
     # @option opts [String] :remote_id The remote id of the payees.
     # @option opts [PayeeType] :payee_type The onboarded status of the payees.
-    # @option opts [String] :payee_country The country of the payees.
+    # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
     # @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=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
-    # @return [Array<(PayeeResponse, Integer, Hash)>] PayeeResponse data, response status code and response headers
+    # @return [Array<(PagedPayeeResponse, Integer, Hash)>] PagedPayeeResponse data, response status code and response headers
     def list_payees_with_http_info(payor_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees ...'
@@ -297,7 +297,7 @@ module VeloPayments
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'PayeeResponse' 
+      return_type = opts[:return_type] || 'PagedPayeeResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']
@@ -317,5 +317,173 @@ module VeloPayments
       end
       return data, status_code, headers
     end
+
+    # List Payees
+    # Get a paginated response listing the payees for a payor.
+    # @param payor_id [String] The account owner Payor ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [WatchlistStatus] :ofac_status The watchlistStatus of the payees.
+    # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
+    # @option opts [String] :email Email address
+    # @option opts [String] :display_name The display name of the payees.
+    # @option opts [String] :remote_id The remote id of the payees.
+    # @option opts [PayeeType] :payee_type The onboarded status of the payees.
+    # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
+    # @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&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus.  (default to 'displayName:asc')
+    # @return [PagedPayeeResponse2]
+    def list_payees_v3(payor_id, opts = {})
+      data, _status_code, _headers = list_payees_v3_with_http_info(payor_id, opts)
+      data
+    end
+
+    # List Payees
+    # Get a paginated response listing the payees for a payor.
+    # @param payor_id [String] The account owner Payor ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [WatchlistStatus] :ofac_status The watchlistStatus of the payees.
+    # @option opts [OnboardedStatus] :onboarded_status The onboarded status of the payees.
+    # @option opts [String] :email Email address
+    # @option opts [String] :display_name The display name of the payees.
+    # @option opts [String] :remote_id The remote id of the payees.
+    # @option opts [PayeeType] :payee_type The onboarded status of the payees.
+    # @option opts [String] :payee_country The country of the payee - 2 letter ISO 3166-1 country code (upper case)
+    # @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&#x3D;onboardedStatus:asc,name:asc) Default is name:asc &#39;name&#39; is treated as company name for companies - last name + &#39;,&#39; + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. 
+    # @return [Array<(PagedPayeeResponse2, Integer, Hash)>] PagedPayeeResponse2 data, response status code and response headers
+    def list_payees_v3_with_http_info(payor_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeesApi.list_payees_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 PayeesApi.list_payees_v3"
+      end
+      pattern = Regexp.new(/[a-zA-Z]+[:desc|:asc]/)
+      if @api_client.config.client_side_validation && !opts[:'sort'].nil? && opts[:'sort'] !~ pattern
+        fail ArgumentError, "invalid value for 'opts[:\"sort\"]' when calling PayeesApi.list_payees_v3, must conform to the pattern #{pattern}."
+      end
+
+      # resource path
+      local_var_path = '/v3/payees'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'payorId'] = payor_id
+      query_params[:'ofacStatus'] = opts[:'ofac_status'] if !opts[:'ofac_status'].nil?
+      query_params[:'onboardedStatus'] = opts[:'onboarded_status'] if !opts[:'onboarded_status'].nil?
+      query_params[:'Email'] = opts[:'email'] if !opts[:'email'].nil?
+      query_params[:'displayName'] = opts[:'display_name'] if !opts[:'display_name'].nil?
+      query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'payeeType'] = opts[:'payee_type'] if !opts[:'payee_type'].nil?
+      query_params[:'payeeCountry'] = opts[:'payee_country'] if !opts[:'payee_country'].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] || 'PagedPayeeResponse2' 
+
+      # 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: PayeesApi#list_payees_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Update Payee Remote Id
+    # Update the remote Id for the given Payee Id.
+    # @param payee_id [String] The UUID of the payee.
+    # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def v1_payees_payee_id_remote_id_update_post(payee_id, update_remote_id_request, opts = {})
+      v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts)
+      nil
+    end
+
+    # Update Payee Remote Id
+    # Update the remote Id for the given Payee Id.
+    # @param payee_id [String] The UUID of the payee.
+    # @param update_remote_id_request [UpdateRemoteIdRequest] Request to update payee remote id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def v1_payees_payee_id_remote_id_update_post_with_http_info(payee_id, update_remote_id_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayeesApi.v1_payees_payee_id_remote_id_update_post ...'
+      end
+      # verify the required parameter 'payee_id' is set
+      if @api_client.config.client_side_validation && payee_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payee_id' when calling PayeesApi.v1_payees_payee_id_remote_id_update_post"
+      end
+      # verify the required parameter 'update_remote_id_request' is set
+      if @api_client.config.client_side_validation && update_remote_id_request.nil?
+        fail ArgumentError, "Missing the required parameter 'update_remote_id_request' when calling PayeesApi.v1_payees_payee_id_remote_id_update_post"
+      end
+      # resource path
+      local_var_path = '/v1/payees/{payeeId}/remoteIdUpdate'.sub('{' + 'payeeId' + '}', CGI.escape(payee_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(update_remote_id_request) 
+
+      # return_type
+      return_type = opts[:return_type] 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayeesApi#v1_payees_payee_id_remote_id_update_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end