velopayments 2.17.8 → 2.18.31.beta1

data/lib/velopayments/api/funding_manager_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.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -20,7 +20,7 @@ module VeloPayments
       @api_client = api_client
     end
     # Create Funding Request
-    # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo  (202 - accepted, 400 - invalid request body, 404 - source account not found).
+    # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
     # @param source_account_id [String] Source account id
     # @param funding_request_v1 [FundingRequestV1] Body to included ammount to be funded
     # @param [Hash] opts the optional parameters
@@ -31,7 +31,7 @@ module VeloPayments
     end
 
     # Create Funding Request
-    # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo  (202 - accepted, 400 - invalid request body, 404 - source account not found).
+    # Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo.
     # @param source_account_id [String] Source account id
     # @param funding_request_v1 [FundingRequestV1] Body to included ammount to be funded
     # @param [Hash] opts the optional parameters
@@ -56,6 +56,8 @@ module VeloPayments
 
       # 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'])
 
@@ -124,6 +126,8 @@ module VeloPayments
 
       # 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'])
 
@@ -155,6 +159,145 @@ module VeloPayments
       return data, status_code, headers
     end
 
+    # Get Funding Account
+    # Get Funding Account by ID
+    # @param funding_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :sensitive  (default to false)
+    # @return [FundingAccountResponse]
+    def get_funding_account(funding_account_id, opts = {})
+      data, _status_code, _headers = get_funding_account_with_http_info(funding_account_id, opts)
+      data
+    end
+
+    # Get Funding Account
+    # Get Funding Account by ID
+    # @param funding_account_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :sensitive 
+    # @return [Array<(FundingAccountResponse, Integer, Hash)>] FundingAccountResponse data, response status code and response headers
+    def get_funding_account_with_http_info(funding_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_funding_account ...'
+      end
+      # verify the required parameter 'funding_account_id' is set
+      if @api_client.config.client_side_validation && funding_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'funding_account_id' when calling FundingManagerApi.get_funding_account"
+      end
+      # resource path
+      local_var_path = '/v1/fundingAccounts/{fundingAccountId}'.sub('{' + 'fundingAccountId' + '}', CGI.escape(funding_account_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] || 'FundingAccountResponse' 
+
+      # 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: FundingManagerApi#get_funding_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Funding Accounts
+    # Get the source accounts.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payor_id 
+    # @option opts [String] :source_account_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  (default to 'accountName:asc')
+    # @option opts [Boolean] :sensitive  (default to false)
+    # @return [ListFundingAccountsResponse]
+    def get_funding_accounts(opts = {})
+      data, _status_code, _headers = get_funding_accounts_with_http_info(opts)
+      data
+    end
+
+    # Get Funding Accounts
+    # Get the source accounts.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payor_id 
+    # @option opts [String] :source_account_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 
+    # @option opts [Boolean] :sensitive 
+    # @return [Array<(ListFundingAccountsResponse, Integer, Hash)>] ListFundingAccountsResponse data, response status code and response headers
+    def get_funding_accounts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_funding_accounts ...'
+      end
+      # resource path
+      local_var_path = '/v1/fundingAccounts'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
+      query_params[:'sourceAccountId'] = opts[:'source_account_id'] if !opts[:'source_account_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?
+      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] || 'ListFundingAccountsResponse' 
+
+      # 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: FundingManagerApi#get_funding_accounts\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
@@ -163,8 +306,8 @@ module VeloPayments
     # @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: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount. 
     # @return [GetFundingsResponse]
-    def get_fundings(opts = {})
-      data, _status_code, _headers = get_fundings_with_http_info(opts)
+    def get_fundings_v1(opts = {})
+      data, _status_code, _headers = get_fundings_v1_with_http_info(opts)
       data
     end
 
@@ -176,9 +319,9 @@ module VeloPayments
     # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
     # @option opts [String] :sort List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; 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
-    def get_fundings_with_http_info(opts = {})
+    def get_fundings_v1_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_fundings ...'
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_fundings_v1 ...'
       end
       # resource path
       local_var_path = '/v1/paymentaudit/fundings'
@@ -218,7 +361,7 @@ module VeloPayments
 
       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: FundingManagerApi#get_fundings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: FundingManagerApi#get_fundings_v1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
@@ -489,27 +632,27 @@ module VeloPayments
       return data, status_code, headers
     end
 
-    # List Funding changes
-    # Get a paginated response listing funding changes.
-    # @param payor_id [String] The Payor ID to find associated funding records
-    # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+    # Get Funding Audit Delta
+    # Get funding audit deltas for a payor
+    # @param payor_id [String] 
+    # @param updated_since [DateTime] 
     # @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 [FundingDeltaResponse]
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
+    # @return [PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse]
     def list_funding_audit_deltas(payor_id, updated_since, opts = {})
       data, _status_code, _headers = list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts)
       data
     end
 
-    # List Funding changes
-    # Get a paginated response listing funding changes.
-    # @param payor_id [String] The Payor ID to find associated funding records
-    # @param updated_since [DateTime] The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+    # Get Funding Audit Delta
+    # Get funding audit deltas for a payor
+    # @param payor_id [String] 
+    # @param updated_since [DateTime] 
     # @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<(FundingDeltaResponse, Integer, Hash)>] FundingDeltaResponse data, response status code and response headers
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+    # @return [Array<(PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse, Integer, Hash)>] PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse data, response status code and response headers
     def list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: FundingManagerApi.list_funding_audit_deltas ...'
@@ -544,7 +687,7 @@ module VeloPayments
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'FundingDeltaResponse' 
+      return_type = opts[:return_type] || 'PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['OAuth2']
@@ -602,6 +745,8 @@ module VeloPayments
 
       # 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'])
 
@@ -632,5 +777,75 @@ module VeloPayments
       end
       return data, status_code, headers
     end
+
+    # Transfer Funds between source accounts
+    # Transfer funds between source accounts for a Payor. The 'from' source account is identified in the URL, and is the account which will be debited. The 'to' (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the 'from' source account, otherwise the transfer attempt will fail.
+    # @param source_account_id [String] The &#39;from&#39; source account id, which will be debited
+    # @param transfer_request [TransferRequest] Body
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def transfer_funds(source_account_id, transfer_request, opts = {})
+      transfer_funds_with_http_info(source_account_id, transfer_request, opts)
+      nil
+    end
+
+    # Transfer Funds between source accounts
+    # Transfer funds between source accounts for a Payor. The &#39;from&#39; source account is identified in the URL, and is the account which will be debited. The &#39;to&#39; (destination) source account is in the body, and is the account which will be credited. Both source accounts must belong to the same Payor. There must be sufficient balance in the &#39;from&#39; source account, otherwise the transfer attempt will fail.
+    # @param source_account_id [String] The &#39;from&#39; source account id, which will be debited
+    # @param transfer_request [TransferRequest] Body
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def transfer_funds_with_http_info(source_account_id, transfer_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.transfer_funds ...'
+      end
+      # verify the required parameter 'source_account_id' is set
+      if @api_client.config.client_side_validation && source_account_id.nil?
+        fail ArgumentError, "Missing the required parameter 'source_account_id' when calling FundingManagerApi.transfer_funds"
+      end
+      # verify the required parameter 'transfer_request' is set
+      if @api_client.config.client_side_validation && transfer_request.nil?
+        fail ArgumentError, "Missing the required parameter 'transfer_request' when calling FundingManagerApi.transfer_funds"
+      end
+      # resource path
+      local_var_path = '/v2/sourceAccounts/{sourceAccountId}/transfers'.sub('{' + 'sourceAccountId' + '}', CGI.escape(source_account_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(transfer_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: FundingManagerApi#transfer_funds\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end

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.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -24,8 +24,8 @@ module VeloPayments
     # @param payout_id [String] Id of the payout
     # @param [Hash] opts the optional parameters
     # @return [PayoutSummaryResponse]
-    def v3_payouts_payout_id_get(payout_id, opts = {})
-      data, _status_code, _headers = v3_payouts_payout_id_get_with_http_info(payout_id, opts)
+    def get_payout_summary_v3(payout_id, opts = {})
+      data, _status_code, _headers = get_payout_summary_v3_with_http_info(payout_id, opts)
       data
     end
 
@@ -34,13 +34,13 @@ module VeloPayments
     # @param payout_id [String] Id of the payout
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayoutSummaryResponse, Integer, Hash)>] PayoutSummaryResponse data, response status code and response headers
-    def v3_payouts_payout_id_get_with_http_info(payout_id, opts = {})
+    def get_payout_summary_v3_with_http_info(payout_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: GetPayoutApi.v3_payouts_payout_id_get ...'
+        @api_client.config.logger.debug 'Calling API: GetPayoutApi.get_payout_summary_v3 ...'
       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 GetPayoutApi.v3_payouts_payout_id_get"
+        fail ArgumentError, "Missing the required parameter 'payout_id' when calling GetPayoutApi.get_payout_summary_v3"
       end
       # resource path
       local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
@@ -76,7 +76,7 @@ module VeloPayments
 
       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: GetPayoutApi#v3_payouts_payout_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: GetPayoutApi#get_payout_summary_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end

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.17.8
+The version of the OpenAPI document: 2.18.31
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 4.2.3-SNAPSHOT
 
 =end
 
@@ -24,8 +24,8 @@ module VeloPayments
     # @param payout_id [String] Id of the payout
     # @param [Hash] opts the optional parameters
     # @return [nil]
-    def v3_payouts_payout_id_post(payout_id, opts = {})
-      v3_payouts_payout_id_post_with_http_info(payout_id, opts)
+    def instruct_payout_v3(payout_id, opts = {})
+      instruct_payout_v3_with_http_info(payout_id, opts)
       nil
     end
 
@@ -34,13 +34,13 @@ module VeloPayments
     # @param payout_id [String] Id of the payout
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def v3_payouts_payout_id_post_with_http_info(payout_id, opts = {})
+    def instruct_payout_v3_with_http_info(payout_id, opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: InstructPayoutApi.v3_payouts_payout_id_post ...'
+        @api_client.config.logger.debug 'Calling API: InstructPayoutApi.instruct_payout_v3 ...'
       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 InstructPayoutApi.v3_payouts_payout_id_post"
+        fail ArgumentError, "Missing the required parameter 'payout_id' when calling InstructPayoutApi.instruct_payout_v3"
       end
       # resource path
       local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
@@ -74,7 +74,7 @@ module VeloPayments
 
       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: InstructPayoutApi#v3_payouts_payout_id_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: InstructPayoutApi#instruct_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end