velopayments 2.18.113 → 2.23.78.beta1

data/lib/velopayments/api/payors_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.18.113
+The version of the OpenAPI document: 2.23.78
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 5.0.0-SNAPSHOT
 
 =end
 
@@ -21,7 +21,7 @@ module VeloPayments
     end
     # Get Payor
     # Get a Single Payor by Id. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [PayorV1]
     def get_payor_by_id(payor_id, opts = {})
@@ -31,7 +31,7 @@ module VeloPayments
 
     # Get Payor
     # Get a Single Payor by Id. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayorV1, Integer, Hash)>] PayorV1 data, response status code and response headers
     def get_payor_by_id_with_http_info(payor_id, opts = {})
@@ -57,15 +57,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PayorV1' 
+      return_type = opts[:debug_return_type] || 'PayorV1'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.get_payor_by_id",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -83,7 +84,7 @@ module VeloPayments
 
     # Get Payor
     # Get a Single Payor by Id. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [PayorV2]
     def get_payor_by_id_v2(payor_id, opts = {})
@@ -93,7 +94,7 @@ module VeloPayments
 
     # Get Payor
     # Get a Single Payor by Id. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayorV2, Integer, Hash)>] PayorV2 data, response status code and response headers
     def get_payor_by_id_v2_with_http_info(payor_id, opts = {})
@@ -119,15 +120,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PayorV2' 
+      return_type = opts[:debug_return_type] || 'PayorV2'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.get_payor_by_id_v2",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -145,7 +147,7 @@ module VeloPayments
 
     # Add Logo
     # Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @option opts [File] :logo 
     # @return [nil]
@@ -156,7 +158,7 @@ module VeloPayments
 
     # Add Logo
     # Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @option opts [File] :logo 
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -186,15 +188,16 @@ module VeloPayments
       form_params['logo'] = opts[:'logo'] if !opts[:'logo'].nil?
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_add_payor_logo",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -212,7 +215,7 @@ module VeloPayments
 
     # Create API Key
     # Create an an API key for the given payor Id and application Id
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param application_id [String] Application ID
     # @param payor_create_api_key_request [PayorCreateApiKeyRequest] Details of application API key to create
     # @param [Hash] opts the optional parameters
@@ -224,7 +227,7 @@ module VeloPayments
 
     # Create API Key
     # Create an an API key for the given payor Id and application Id
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param application_id [String] Application ID
     # @param payor_create_api_key_request [PayorCreateApiKeyRequest] Details of application API key to create
     # @param [Hash] opts the optional parameters
@@ -262,15 +265,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(payor_create_api_key_request) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(payor_create_api_key_request)
 
       # return_type
-      return_type = opts[:return_type] || 'PayorCreateApiKeyResponse' 
+      return_type = opts[:debug_return_type] || 'PayorCreateApiKeyResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_create_api_key_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -288,7 +292,7 @@ module VeloPayments
 
     # Create Application
     # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param payor_create_application_request [PayorCreateApplicationRequest] Details of application to create
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -299,7 +303,7 @@ module VeloPayments
 
     # Create Application
     # Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param payor_create_application_request [PayorCreateApplicationRequest] Details of application to create
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -332,15 +336,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(payor_create_application_request) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(payor_create_application_request)
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_create_application_request",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -358,7 +363,7 @@ module VeloPayments
 
     # Reminder Email Opt-Out
     # Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param payor_email_opt_out_request [PayorEmailOptOutRequest] Reminder Emails Opt-Out Request
     # @param [Hash] opts the optional parameters
     # @return [nil]
@@ -369,7 +374,7 @@ module VeloPayments
 
     # Reminder Email Opt-Out
     # Update the emailRemindersOptOut field for a Payor. This API can be used to opt out or opt into Payor Reminder emails. These emails are typically around payee events such as payees registering and onboarding. 
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param payor_email_opt_out_request [PayorEmailOptOutRequest] Reminder Emails Opt-Out Request
     # @param [Hash] opts the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -402,15 +407,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(payor_email_opt_out_request) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(payor_email_opt_out_request)
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_email_opt_out",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -428,7 +434,7 @@ module VeloPayments
 
     # Get Branding
     # Get the payor branding details.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [PayorBrandingResponse]
     def payor_get_branding(payor_id, opts = {})
@@ -438,7 +444,7 @@ module VeloPayments
 
     # Get Branding
     # Get the payor branding details.
-    # @param payor_id [String] The account owner Payor ID
+    # @param payor_id [String] The Payor Id
     # @param [Hash] opts the optional parameters
     # @return [Array<(PayorBrandingResponse, Integer, Hash)>] PayorBrandingResponse data, response status code and response headers
     def payor_get_branding_with_http_info(payor_id, opts = {})
@@ -464,15 +470,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PayorBrandingResponse' 
+      return_type = opts[:debug_return_type] || 'PayorBrandingResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_get_branding",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -529,15 +536,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] 
+      post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:return_type] || 'PayorLinksResponse' 
+      return_type = opts[:debug_return_type] || 'PayorLinksResponse'
 
       # auth_names
-      auth_names = opts[:auth_names] || ['OAuth2']
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
 
       new_options = opts.merge(
+        :operation => :"PayorsApi.payor_links",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/velopayments/api/payors_private_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.18.113
+The version of the OpenAPI document: 2.23.78
 
 Generated by: https://openapi-generator.tech
-OpenAPI Generator version: 4.2.1-SNAPSHOT
+OpenAPI Generator version: 5.0.0-SNAPSHOT
 
 =end
 
@@ -59,15 +59,16 @@ module VeloPayments
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:body] || @api_client.object_to_http_body(create_payor_link_request) 
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(create_payor_link_request)
 
       # return_type
-      return_type = opts[:return_type] 
+      return_type = opts[:debug_return_type]
 
       # auth_names
-      auth_names = opts[:auth_names] || ['oAuthVeloBackOffice']
+      auth_names = opts[:debug_auth_names] || ['oAuthVeloBackOffice']
 
       new_options = opts.merge(
+        :operation => :"PayorsPrivateApi.create_payor_links",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,

data/lib/velopayments/api/payout_service_api.rb

@@ -0,0 +1,506 @@
+=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.23.78
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 5.0.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module VeloPayments
+  class PayoutServiceApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Create a quote for the payout
+    # Create quote for a payout
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [QuoteResponseV3]
+    def create_quote_for_payout_v3(payout_id, opts = {})
+      data, _status_code, _headers = create_quote_for_payout_v3_with_http_info(payout_id, opts)
+      data
+    end
+
+    # Create a quote for the payout
+    # Create quote for a payout
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(QuoteResponseV3, Integer, Hash)>] QuoteResponseV3 data, response status code and response headers
+    def create_quote_for_payout_v3_with_http_info(payout_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.create_quote_for_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 PayoutServiceApi.create_quote_for_payout_v3"
+      end
+      # resource path
+      local_var_path = '/v3/payouts/{payoutId}/quote'.sub('{' + 'payoutId' + '}', CGI.escape(payout_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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'QuoteResponseV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.create_quote_for_payout_v3",
+        :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: PayoutServiceApi#create_quote_for_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Retrieve payments for a payout
+    # Retrieve payments for a payout
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal 
+    # @option opts [String] :remote_id The remote id of the payees.
+    # @option opts [String] :payor_payment_id Payor&#39;s Id of the Payment
+    # @option opts [String] :source_account_name Physical Account Name
+    # @option opts [String] :payment_memo Payment Memo of the Payment
+    # @option opts [Integer] :page_size The number of results to return in a page (default to 25)
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @return [PagedPaymentsResponseV3]
+    def get_payments_for_payout_v3(payout_id, opts = {})
+      data, _status_code, _headers = get_payments_for_payout_v3_with_http_info(payout_id, opts)
+      data
+    end
+
+    # Retrieve payments for a payout
+    # Retrieve payments for a payout
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :status Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal 
+    # @option opts [String] :remote_id The remote id of the payees.
+    # @option opts [String] :payor_payment_id Payor&#39;s Id of the Payment
+    # @option opts [String] :source_account_name Physical Account Name
+    # @option opts [String] :payment_memo Payment Memo of the Payment
+    # @option opts [Integer] :page_size The number of results to return in a page
+    # @option opts [Integer] :page Page number. Default is 1.
+    # @return [Array<(PagedPaymentsResponseV3, Integer, Hash)>] PagedPaymentsResponseV3 data, response status code and response headers
+    def get_payments_for_payout_v3_with_http_info(payout_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.get_payments_for_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 PayoutServiceApi.get_payments_for_payout_v3"
+      end
+      allowable_values = ["ACCEPTED", "REJECTED", "WITHDRAWN", "WITHDRAWABLE"]
+      if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
+        fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
+      end
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] > 100
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PayoutServiceApi.get_payments_for_payout_v3, must be smaller than or equal to 100.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'page_size'].nil? && opts[:'page_size'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"page_size"]" when calling PayoutServiceApi.get_payments_for_payout_v3, must be greater than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/v3/payouts/{payoutId}/payments'.sub('{' + 'payoutId' + '}', CGI.escape(payout_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'remoteId'] = opts[:'remote_id'] if !opts[:'remote_id'].nil?
+      query_params[:'payorPaymentId'] = opts[:'payor_payment_id'] if !opts[:'payor_payment_id'].nil?
+      query_params[:'sourceAccountName'] = opts[:'source_account_name'] if !opts[:'source_account_name'].nil?
+      query_params[:'paymentMemo'] = opts[:'payment_memo'] if !opts[:'payment_memo'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PagedPaymentsResponseV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.get_payments_for_payout_v3",
+        :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: PayoutServiceApi#get_payments_for_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Payout Summary
+    # Get payout summary - returns the current state of the payout.
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [PayoutSummaryResponseV3]
+    def get_payout_summary_v3(payout_id, opts = {})
+      data, _status_code, _headers = get_payout_summary_v3_with_http_info(payout_id, opts)
+      data
+    end
+
+    # Get Payout Summary
+    # Get payout summary - returns the current state of the payout.
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PayoutSummaryResponseV3, Integer, Hash)>] PayoutSummaryResponseV3 data, response status code and response headers
+    def get_payout_summary_v3_with_http_info(payout_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.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 PayoutServiceApi.get_payout_summary_v3"
+      end
+      # resource path
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'PayoutSummaryResponseV3'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.get_payout_summary_v3",
+        :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: PayoutServiceApi#get_payout_summary_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Instruct Payout
+    # Instruct a payout to be made for the specified payoutId.
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def instruct_payout_v3(payout_id, opts = {})
+      instruct_payout_v3_with_http_info(payout_id, opts)
+      nil
+    end
+
+    # Instruct Payout
+    # Instruct a payout to be made for the specified payoutId.
+    # @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 instruct_payout_v3_with_http_info(payout_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.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 PayoutServiceApi.instruct_payout_v3"
+      end
+      # resource path
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.instruct_payout_v3",
+        :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: PayoutServiceApi#instruct_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Submit Payout
+    # <p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p>  with no decimal places. 
+    # @param create_payout_request_v3 [CreatePayoutRequestV3] Post amount to transfer using stored funding account details.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def submit_payout_v3(create_payout_request_v3, opts = {})
+      submit_payout_v3_with_http_info(create_payout_request_v3, opts)
+      nil
+    end
+
+    # Submit Payout
+    # &lt;p&gt;Create a new payout and return a location header with a link to get the payout.&lt;/p&gt; &lt;p&gt;Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.&lt;/p&gt; &lt;p&gt;The results can be obtained by issuing a HTTP GET to the URL returned in the location header.&lt;/p&gt; &lt;p&gt;**NOTE:** amount values in payments must be in &#39;minor units&#39; format. E.g. cents for USD, pence for GBP etc.&lt;/p&gt;  with no decimal places. 
+    # @param create_payout_request_v3 [CreatePayoutRequestV3] Post amount to transfer using stored funding account details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def submit_payout_v3_with_http_info(create_payout_request_v3, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.submit_payout_v3 ...'
+      end
+      # verify the required parameter 'create_payout_request_v3' is set
+      if @api_client.config.client_side_validation && create_payout_request_v3.nil?
+        fail ArgumentError, "Missing the required parameter 'create_payout_request_v3' when calling PayoutServiceApi.submit_payout_v3"
+      end
+      # resource path
+      local_var_path = '/v3/payouts'
+
+      # 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[:debug_body] || @api_client.object_to_http_body(create_payout_request_v3)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.submit_payout_v3",
+        :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: PayoutServiceApi#submit_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Withdraw a Payment
+    # <p>withdraw a payment </p> <p>There are a variety of reasons why this can fail</p> <ul>     <li>the payment must be in a state of 'accepted' or 'unfunded'</li>     <li>the payout must not be in a state of 'instructed'</li> </ul> 
+    # @param payment_id [String] Id of the Payment
+    # @param withdraw_payment_request [WithdrawPaymentRequest] details for withdrawal
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def withdraw_payment(payment_id, withdraw_payment_request, opts = {})
+      withdraw_payment_with_http_info(payment_id, withdraw_payment_request, opts)
+      nil
+    end
+
+    # Withdraw a Payment
+    # &lt;p&gt;withdraw a payment &lt;/p&gt; &lt;p&gt;There are a variety of reasons why this can fail&lt;/p&gt; &lt;ul&gt;     &lt;li&gt;the payment must be in a state of &#39;accepted&#39; or &#39;unfunded&#39;&lt;/li&gt;     &lt;li&gt;the payout must not be in a state of &#39;instructed&#39;&lt;/li&gt; &lt;/ul&gt; 
+    # @param payment_id [String] Id of the Payment
+    # @param withdraw_payment_request [WithdrawPaymentRequest] details for withdrawal
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def withdraw_payment_with_http_info(payment_id, withdraw_payment_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.withdraw_payment ...'
+      end
+      # verify the required parameter 'payment_id' is set
+      if @api_client.config.client_side_validation && payment_id.nil?
+        fail ArgumentError, "Missing the required parameter 'payment_id' when calling PayoutServiceApi.withdraw_payment"
+      end
+      # verify the required parameter 'withdraw_payment_request' is set
+      if @api_client.config.client_side_validation && withdraw_payment_request.nil?
+        fail ArgumentError, "Missing the required parameter 'withdraw_payment_request' when calling PayoutServiceApi.withdraw_payment"
+      end
+      # resource path
+      local_var_path = '/v1/payments/{paymentId}/withdraw'.sub('{' + 'paymentId' + '}', CGI.escape(payment_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[:debug_body] || @api_client.object_to_http_body(withdraw_payment_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.withdraw_payment",
+        :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: PayoutServiceApi#withdraw_payment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Withdraw Payout
+    # Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
+    # @param payout_id [String] Id of the payout
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def withdraw_payout_v3(payout_id, opts = {})
+      withdraw_payout_v3_with_http_info(payout_id, opts)
+      nil
+    end
+
+    # Withdraw Payout
+    # Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
+    # @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 withdraw_payout_v3_with_http_info(payout_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: PayoutServiceApi.withdraw_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 PayoutServiceApi.withdraw_payout_v3"
+      end
+      # resource path
+      local_var_path = '/v3/payouts/{payoutId}'.sub('{' + 'payoutId' + '}', CGI.escape(payout_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[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['OAuth2']
+
+      new_options = opts.merge(
+        :operation => :"PayoutServiceApi.withdraw_payout_v3",
+        :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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: PayoutServiceApi#withdraw_payout_v3\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end