velopayments 2.11.73

data/docs/SupportedCountry.md

@@ -0,0 +1,19 @@
+# VeloPayments::SupportedCountry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iso_country_code** | **String** |  | [optional] 
+**currencies** | **Array<String>** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SupportedCountry.new(iso_country_code: null,
+                                 currencies: null)
+```
+
+

data/docs/SupportedCurrency.md

@@ -0,0 +1,19 @@
+# VeloPayments::SupportedCurrency
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currency** | **String** | ISO Currency Code | [optional] 
+**max_payment_amount** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SupportedCurrency.new(currency: null,
+                                 max_payment_amount: null)
+```
+
+

data/docs/SupportedCurrencyResponse.md

@@ -0,0 +1,17 @@
+# VeloPayments::SupportedCurrencyResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**currencies** | [**Array<SupportedCurrency>**](SupportedCurrency.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SupportedCurrencyResponse.new(currencies: null)
+```
+
+

data/docs/WithdrawPayoutApi.md

@@ -0,0 +1,60 @@
+# VeloPayments::WithdrawPayoutApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**v3_payouts_payout_id_delete**](WithdrawPayoutApi.md#v3_payouts_payout_id_delete) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
+
+
+
+## v3_payouts_payout_id_delete
+
+> v3_payouts_payout_id_delete(payout_id)
+
+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.
+
+### Example
+
+```ruby
+# load the gem
+require 'velopayments'
+# setup authorization
+VeloPayments.configure do |config|
+  # Configure OAuth2 access token for authorization: OAuth2
+  config.access_token = 'YOUR ACCESS TOKEN'
+end
+
+api_instance = VeloPayments::WithdrawPayoutApi.new
+payout_id = 'payout_id_example' # String | Id of the payout
+
+begin
+  #Withdraw Payout
+  api_instance.v3_payouts_payout_id_delete(payout_id)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling WithdrawPayoutApi->v3_payouts_payout_id_delete: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| Id of the payout | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/lib/velopayments.rb

@@ -0,0 +1,124 @@
+=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. 
+
+OpenAPI spec version: 2.11.73
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+# Common files
+require 'velopayments/api_client'
+require 'velopayments/api_error'
+require 'velopayments/version'
+require 'velopayments/configuration'
+
+# Models
+require 'velopayments/models/address'
+require 'velopayments/models/challenge'
+require 'velopayments/models/company'
+require 'velopayments/models/create_payee'
+require 'velopayments/models/create_payees_csv_request'
+require 'velopayments/models/create_payees_csv_response'
+require 'velopayments/models/create_payees_request'
+require 'velopayments/models/create_payment_channel'
+require 'velopayments/models/create_payout_request'
+require 'velopayments/models/failed_submission'
+require 'velopayments/models/funding_audit'
+require 'velopayments/models/funding_event'
+require 'velopayments/models/funding_event_type'
+require 'velopayments/models/funding_request'
+require 'velopayments/models/funding_request2'
+require 'velopayments/models/fx_summary'
+require 'velopayments/models/get_fundings_response'
+require 'velopayments/models/get_payments_for_payout_response'
+require 'velopayments/models/get_payments_for_payout_response_links'
+require 'velopayments/models/get_payments_for_payout_response_page'
+require 'velopayments/models/get_payments_for_payout_response_summary'
+require 'velopayments/models/get_payout_statistics'
+require 'velopayments/models/get_payouts_response'
+require 'velopayments/models/individual'
+require 'velopayments/models/individual_name'
+require 'velopayments/models/invitation_status_response'
+require 'velopayments/models/invite_payee_request'
+require 'velopayments/models/language'
+require 'velopayments/models/list_payments_response'
+require 'velopayments/models/list_source_account_response'
+require 'velopayments/models/marketing_opt_in'
+require 'velopayments/models/ofac_status'
+require 'velopayments/models/onboarded_status'
+require 'velopayments/models/paged_response'
+require 'velopayments/models/paged_response_page'
+require 'velopayments/models/payee'
+require 'velopayments/models/payee_invitation_status'
+require 'velopayments/models/payee_response'
+require 'velopayments/models/payee_type'
+require 'velopayments/models/payment_audit_currency'
+require 'velopayments/models/payment_channel'
+require 'velopayments/models/payment_channel_country'
+require 'velopayments/models/payment_channel_rule'
+require 'velopayments/models/payment_channel_rules_response'
+require 'velopayments/models/payment_event_response'
+require 'velopayments/models/payment_instruction'
+require 'velopayments/models/payment_response'
+require 'velopayments/models/payor'
+require 'velopayments/models/payor_branding_response'
+require 'velopayments/models/payor_create_api_key_request'
+require 'velopayments/models/payor_create_api_key_response'
+require 'velopayments/models/payor_create_application_request'
+require 'velopayments/models/payor_email_opt_out_request'
+require 'velopayments/models/payor_funding_bank_details_update'
+require 'velopayments/models/payor_logo_request'
+require 'velopayments/models/payor_ref'
+require 'velopayments/models/payout_status'
+require 'velopayments/models/payout_summary_audit'
+require 'velopayments/models/payout_summary_response'
+require 'velopayments/models/query_batch_response'
+require 'velopayments/models/quote_fx_summary'
+require 'velopayments/models/quote_response'
+require 'velopayments/models/rejected_payment'
+require 'velopayments/models/social'
+require 'velopayments/models/source_account'
+require 'velopayments/models/source_account_response'
+require 'velopayments/models/source_account_summary'
+require 'velopayments/models/supported_countries_response'
+require 'velopayments/models/supported_country'
+require 'velopayments/models/supported_currency'
+require 'velopayments/models/supported_currency_response'
+
+# APIs
+require 'velopayments/api/countries_api'
+require 'velopayments/api/currencies_api'
+require 'velopayments/api/funding_manager_api'
+require 'velopayments/api/get_payout_api'
+require 'velopayments/api/instruct_payout_api'
+require 'velopayments/api/payee_invitation_api'
+require 'velopayments/api/payees_api'
+require 'velopayments/api/payment_audit_service_api'
+require 'velopayments/api/payor_applications_api'
+require 'velopayments/api/payors_api'
+require 'velopayments/api/payout_history_api'
+require 'velopayments/api/quote_payout_api'
+require 'velopayments/api/submit_payout_api'
+require 'velopayments/api/withdraw_payout_api'
+
+module VeloPayments
+  class << self
+    # Customize default settings for the SDK using block.
+    #   VeloPayments.configure do |config|
+    #     config.username = "xxx"
+    #     config.password = "xxx"
+    #   end
+    # If no block given, return the default Configuration object.
+    def configure
+      if block_given?
+        yield(Configuration.default)
+      else
+        Configuration.default
+      end
+    end
+  end
+end

data/lib/velopayments/api/countries_api.rb

@@ -0,0 +1,116 @@
+=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. 
+
+OpenAPI spec version: 2.11.73
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module VeloPayments
+  class CountriesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List Supported Countries
+    # List the supported countries.
+    # @param [Hash] opts the optional parameters
+    # @return [SupportedCountriesResponse]
+    def list_supported_countries(opts = {})
+      data, _status_code, _headers = list_supported_countries_with_http_info(opts)
+      data
+    end
+
+    # List Supported Countries
+    # List the supported countries.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SupportedCountriesResponse, Integer, Hash)>] SupportedCountriesResponse data, response status code and response headers
+    def list_supported_countries_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CountriesApi.list_supported_countries ...'
+      end
+      # resource path
+      local_var_path = '/v1/supportedCountries'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SupportedCountriesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CountriesApi#list_supported_countries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # List Payment Channel Country Rules
+    # List the country specific payment channel rules.
+    # @param [Hash] opts the optional parameters
+    # @return [PaymentChannelRulesResponse]
+    def v1_payment_channel_rules_get(opts = {})
+      data, _status_code, _headers = v1_payment_channel_rules_get_with_http_info(opts)
+      data
+    end
+
+    # List Payment Channel Country Rules
+    # List the country specific payment channel rules.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(PaymentChannelRulesResponse, Integer, Hash)>] PaymentChannelRulesResponse data, response status code and response headers
+    def v1_payment_channel_rules_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CountriesApi.v1_payment_channel_rules_get ...'
+      end
+      # resource path
+      local_var_path = '/v1/paymentChannelRules'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'PaymentChannelRulesResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CountriesApi#v1_payment_channel_rules_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/velopayments/api/currencies_api.rb

@@ -0,0 +1,69 @@
+=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. 
+
+OpenAPI spec version: 2.11.73
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module VeloPayments
+  class CurrenciesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List Supported Currencies
+    # List the supported currencies.
+    # @param [Hash] opts the optional parameters
+    # @return [SupportedCurrencyResponse]
+    def list_supported_currencies(opts = {})
+      data, _status_code, _headers = list_supported_currencies_with_http_info(opts)
+      data
+    end
+
+    # List Supported Currencies
+    # List the supported currencies.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SupportedCurrencyResponse, Integer, Hash)>] SupportedCurrencyResponse data, response status code and response headers
+    def list_supported_currencies_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: CurrenciesApi.list_supported_currencies ...'
+      end
+      # resource path
+      local_var_path = '/v2/currencies'
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SupportedCurrencyResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CurrenciesApi#list_supported_currencies\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/velopayments/api/funding_manager_api.rb

@@ -0,0 +1,374 @@
+=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. 
+
+OpenAPI spec version: 2.11.73
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.0-SNAPSHOT
+
+=end
+
+require 'uri'
+
+module VeloPayments
+  class FundingManagerApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @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).
+    # @param source_account_id [String] Source account id
+    # @param funding_request [FundingRequest] Body to included ammount to be funded
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def create_ach_funding_request(source_account_id, funding_request, opts = {})
+      create_ach_funding_request_with_http_info(source_account_id, funding_request, opts)
+      nil
+    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).
+    # @param source_account_id [String] Source account id
+    # @param funding_request [FundingRequest] Body to included ammount to be funded
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def create_ach_funding_request_with_http_info(source_account_id, funding_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.create_ach_funding_request ...'
+      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.create_ach_funding_request"
+      end
+      # verify the required parameter 'funding_request' is set
+      if @api_client.config.client_side_validation && funding_request.nil?
+        fail ArgumentError, "Missing the required parameter 'funding_request' when calling FundingManagerApi.create_ach_funding_request"
+      end
+      # resource path
+      local_var_path = '/v1/sourceAccounts/{sourceAccountId}/achFundingRequest'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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 = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(funding_request)
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#create_ach_funding_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    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).
+    # @param source_account_id [String] Source account id
+    # @param funding_request2 [FundingRequest2] Body to included ammount to be funded
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def create_funding_request(source_account_id, funding_request2, opts = {})
+      create_funding_request_with_http_info(source_account_id, funding_request2, opts)
+      nil
+    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).
+    # @param source_account_id [String] Source account id
+    # @param funding_request2 [FundingRequest2] Body to included ammount to be funded
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def create_funding_request_with_http_info(source_account_id, funding_request2, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.create_funding_request ...'
+      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.create_funding_request"
+      end
+      # verify the required parameter 'funding_request2' is set
+      if @api_client.config.client_side_validation && funding_request2.nil?
+        fail ArgumentError, "Missing the required parameter 'funding_request2' when calling FundingManagerApi.create_funding_request"
+      end
+      # resource path
+      local_var_path = '/v2/sourceAccounts/{sourceAccountId}/fundingRequest'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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 = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(funding_request2)
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#create_funding_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Fundings for Payor
+    # Get a list of Fundings for a payor. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payor_id The account owner Payor ID
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
+    # @option opts [String] :sort List of sort fields. Example: &#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)
+      data
+    end
+
+    # Get Fundings for Payor
+    # Get a list of Fundings for a payor. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :payor_id The account owner Payor ID
+    # @option opts [Integer] :page Page number. Default is 1.
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+    # @option opts [String] :sort List of sort fields. Example: &#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 = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_fundings ...'
+      end
+      # resource path
+      local_var_path = '/v1/paymentaudit/fundings'
+
+      # query parameters
+      query_params = {}
+      query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'GetFundingsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#get_fundings\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get details about given source account.
+    # Get details about given source account.
+    # @param source_account_id [String] Source account id
+    # @param [Hash] opts the optional parameters
+    # @return [SourceAccountResponse]
+    def get_source_account(source_account_id, opts = {})
+      data, _status_code, _headers = get_source_account_with_http_info(source_account_id, opts)
+      data
+    end
+
+    # Get details about given source account.
+    # Get details about given source account.
+    # @param source_account_id [String] Source account id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SourceAccountResponse, Integer, Hash)>] SourceAccountResponse data, response status code and response headers
+    def get_source_account_with_http_info(source_account_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_account ...'
+      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.get_source_account"
+      end
+      # resource path
+      local_var_path = '/v1/sourceAccounts/{sourceAccountId}'.sub('{' + 'sourceAccountId' + '}', source_account_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SourceAccountResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#get_source_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get list of source accounts
+    # List source accounts.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :physical_account_name Physical Account Name
+    # @option opts [String] :payor_id The account owner Payor ID
+    # @option opts [Integer] :page Page number. Default is 1. (default to 1)
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100. (default to 25)
+    # @option opts [String] :sort Sort String
+    # @return [ListSourceAccountResponse]
+    def get_source_accounts(opts = {})
+      data, _status_code, _headers = get_source_accounts_with_http_info(opts)
+      data
+    end
+
+    # Get list of source accounts
+    # List source accounts.
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :physical_account_name Physical Account Name
+    # @option opts [String] :payor_id The account owner Payor ID
+    # @option opts [Integer] :page Page number. Default is 1.
+    # @option opts [Integer] :page_size Page size. Default is 25. Max allowable is 100.
+    # @option opts [String] :sort Sort String
+    # @return [Array<(ListSourceAccountResponse, Integer, Hash)>] ListSourceAccountResponse data, response status code and response headers
+    def get_source_accounts_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.get_source_accounts ...'
+      end
+      # resource path
+      local_var_path = '/v1/sourceAccounts'
+
+      # query parameters
+      query_params = {}
+      query_params[:'physicalAccountName'] = opts[:'physical_account_name'] if !opts[:'physical_account_name'].nil?
+      query_params[:'payorId'] = opts[:'payor_id'] if !opts[:'payor_id'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ListSourceAccountResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#get_source_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Set Funding Bank Details
+    # This API allows you to set or update the funding details for the given Payor ID. 
+    # @param payor_id [String] The account owner Payor ID
+    # @param payor_funding_bank_details_update [PayorFundingBankDetailsUpdate] Update Funding bank details of given Payor Id
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def set_payor_funding_bank_details(payor_id, payor_funding_bank_details_update, opts = {})
+      set_payor_funding_bank_details_with_http_info(payor_id, payor_funding_bank_details_update, opts)
+      nil
+    end
+
+    # Set Funding Bank Details
+    # This API allows you to set or update the funding details for the given Payor ID. 
+    # @param payor_id [String] The account owner Payor ID
+    # @param payor_funding_bank_details_update [PayorFundingBankDetailsUpdate] Update Funding bank details of given Payor Id
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def set_payor_funding_bank_details_with_http_info(payor_id, payor_funding_bank_details_update, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FundingManagerApi.set_payor_funding_bank_details ...'
+      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 FundingManagerApi.set_payor_funding_bank_details"
+      end
+      # verify the required parameter 'payor_funding_bank_details_update' is set
+      if @api_client.config.client_side_validation && payor_funding_bank_details_update.nil?
+        fail ArgumentError, "Missing the required parameter 'payor_funding_bank_details_update' when calling FundingManagerApi.set_payor_funding_bank_details"
+      end
+      # resource path
+      local_var_path = '/v1/payors/{payorId}/payorFundingBankDetailsUpdate'.sub('{' + 'payorId' + '}', payor_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(payor_funding_bank_details_update)
+      auth_names = ['OAuth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FundingManagerApi#set_payor_funding_bank_details\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end