velopayments 2.11.73

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b20488f32b4d4e970188356ea2c546e1b635398
+  data.tar.gz: '065478cdce0226559bea264d1201d99416bf8961'
+SHA512:
+  metadata.gz: 79507ee9df11d7f53581ef9dbe0649e1e0046da28cd89fe29821112230a43ee3226d676ef375161bd56af8539e2cd20b274beca8402699b26da711a6e77ca7da
+  data.tar.gz: d00fad2384280411893522e65b510e3a454b81da3a68dd17fdc68cff90bf29cf3a76ff0a69120846999f3b755f1a03b321795f8496ca49843da25340b3d782b2

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    velopayments (2.11.73)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  velopayments!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/Makefile

@@ -0,0 +1,39 @@
+help:
+	@echo ""
+	@echo "\033[0;34m    Velo Payments - Ruby Client (\033[1;34mvelopaymentsapi/velo-ruby\033[0;34m) \033[0m"
+	@echo ""
+	@echo "    To dynamically generate the Ruby client based on a spec issue the following command."
+	@echo "    You can specify the spec by replacing the url parameter"
+	@echo ""
+	@echo "\033[92m    make WORKING_SPEC=https://raw.githubusercontent.com/velopaymentsapi/VeloOpenApi/master/spec/openapi.yaml client \033[0m"
+	@echo ""
+
+clean:
+	rm -Rf lib
+	rm -Rf docs
+	rm -Rf spec
+	rm -f .rspec
+	rm -f README.md
+	rm -Rf .rubocop.yml
+	rm -f Gemfile
+	rm -f Gemfile.lock
+	rm -f Rakefile
+	rm -f *.gemspec
+
+ruby-client:
+	docker run --rm -v ${PWD}:/local openapitools/openapi-generator-cli generate \
+		-i $$WORKING_SPEC \
+		-g ruby \
+		-o /local \
+		-c /local/oa3-config.json
+
+trim:
+	rm -Rf .openapi-generator
+	rm .openapi-generator-ignore
+	rm .travis.yml
+	rm git_push.sh
+
+info:
+	sed -i.bak '1s/.*/# Ruby client for Velo/' README.md && rm README.md.bak
+	
+client: clean ruby-client trim info

data/README.md

@@ -0,0 +1,279 @@
+# Ruby client for Velo
+
+VeloPayments - the Ruby gem for the 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.
+
+
+This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
+
+- API version: 2.11.73
+- Package version: 2.11.73
+- Build package: org.openapitools.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build velopayments.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./velopayments-2.11.73.gem
+```
+
+(for development, run `gem install --dev ./velopayments-2.11.73.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'velopayments', '~> 2.11.73'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'velopayments', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+
+```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::CountriesApi.new
+
+begin
+  #List Supported Countries
+  result = api_instance.list_supported_countries
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling CountriesApi->list_supported_countries: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*VeloPayments::CountriesApi* | [**list_supported_countries**](docs/CountriesApi.md#list_supported_countries) | **GET** /v1/supportedCountries | List Supported Countries
+*VeloPayments::CountriesApi* | [**v1_payment_channel_rules_get**](docs/CountriesApi.md#v1_payment_channel_rules_get) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
+*VeloPayments::CurrenciesApi* | [**list_supported_currencies**](docs/CurrenciesApi.md#list_supported_currencies) | **GET** /v2/currencies | List Supported Currencies
+*VeloPayments::FundingManagerApi* | [**create_ach_funding_request**](docs/FundingManagerApi.md#create_ach_funding_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/achFundingRequest | Create Funding Request
+*VeloPayments::FundingManagerApi* | [**create_funding_request**](docs/FundingManagerApi.md#create_funding_request) | **POST** /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request
+*VeloPayments::FundingManagerApi* | [**get_fundings**](docs/FundingManagerApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
+*VeloPayments::FundingManagerApi* | [**get_source_account**](docs/FundingManagerApi.md#get_source_account) | **GET** /v1/sourceAccounts/{sourceAccountId} | Get details about given source account.
+*VeloPayments::FundingManagerApi* | [**get_source_accounts**](docs/FundingManagerApi.md#get_source_accounts) | **GET** /v1/sourceAccounts | Get list of source accounts
+*VeloPayments::FundingManagerApi* | [**set_payor_funding_bank_details**](docs/FundingManagerApi.md#set_payor_funding_bank_details) | **POST** /v1/payors/{payorId}/payorFundingBankDetailsUpdate | Set Funding Bank Details
+*VeloPayments::GetPayoutApi* | [**v3_payouts_payout_id_get**](docs/GetPayoutApi.md#v3_payouts_payout_id_get) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
+*VeloPayments::InstructPayoutApi* | [**v3_payouts_payout_id_post**](docs/InstructPayoutApi.md#v3_payouts_payout_id_post) | **POST** /v3/payouts/{payoutId} | Instruct Payout
+*VeloPayments::PayeeInvitationApi* | [**get_payor**](docs/PayeeInvitationApi.md#get_payor) | **GET** /v1/payees/payors/{payorId}/invitationStatus | Get Payee Invitation Status
+*VeloPayments::PayeeInvitationApi* | [**resend_payee_invite**](docs/PayeeInvitationApi.md#resend_payee_invite) | **POST** /v1/payees/{payeeId}/invite | Resend Payee Invite
+*VeloPayments::PayeeInvitationApi* | [**v2_create_payee**](docs/PayeeInvitationApi.md#v2_create_payee) | **POST** /v2/payees | Intiate Payee Creation
+*VeloPayments::PayeeInvitationApi* | [**v2_query_batch_status**](docs/PayeeInvitationApi.md#v2_query_batch_status) | **GET** /v2/payees/batch/{batchId} | Query Batch Status
+*VeloPayments::PayeesApi* | [**delete_payee_by_id**](docs/PayeesApi.md#delete_payee_by_id) | **DELETE** /v1/payees/{payeeId} | Delete Payee by Id
+*VeloPayments::PayeesApi* | [**get_payee_by_id**](docs/PayeesApi.md#get_payee_by_id) | **GET** /v1/payees/{payeeId} | Get Payee by Id
+*VeloPayments::PayeesApi* | [**list_payees**](docs/PayeesApi.md#list_payees) | **GET** /v1/payees | List Payees
+*VeloPayments::PaymentAuditServiceApi* | [**export_transactions_csv**](docs/PaymentAuditServiceApi.md#export_transactions_csv) | **GET** /v4/paymentaudit/transactions | Export Transactions
+*VeloPayments::PaymentAuditServiceApi* | [**get_fundings**](docs/PaymentAuditServiceApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
+*VeloPayments::PaymentAuditServiceApi* | [**get_payment_details**](docs/PaymentAuditServiceApi.md#get_payment_details) | **GET** /v3/paymentaudit/payments/{paymentId} | Get Payment
+*VeloPayments::PaymentAuditServiceApi* | [**get_payments_for_payout**](docs/PaymentAuditServiceApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
+*VeloPayments::PaymentAuditServiceApi* | [**get_payouts_for_payor**](docs/PaymentAuditServiceApi.md#get_payouts_for_payor) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
+*VeloPayments::PaymentAuditServiceApi* | [**list_payments_audit**](docs/PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
+*VeloPayments::PayorApplicationsApi* | [**payor_create_api_key_request**](docs/PayorApplicationsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
+*VeloPayments::PayorApplicationsApi* | [**payor_create_application_request**](docs/PayorApplicationsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
+*VeloPayments::PayorsApi* | [**get_payor_by_id**](docs/PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
+*VeloPayments::PayorsApi* | [**payor_add_payor_logo**](docs/PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
+*VeloPayments::PayorsApi* | [**payor_email_opt_out**](docs/PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out
+*VeloPayments::PayorsApi* | [**payor_get_branding**](docs/PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding
+*VeloPayments::PayoutHistoryApi* | [**get_payments_for_payout**](docs/PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
+*VeloPayments::PayoutHistoryApi* | [**get_payout_stats**](docs/PayoutHistoryApi.md#get_payout_stats) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
+*VeloPayments::QuotePayoutApi* | [**v3_payouts_payout_id_quote_post**](docs/QuotePayoutApi.md#v3_payouts_payout_id_quote_post) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout
+*VeloPayments::SubmitPayoutApi* | [**submit_payout**](docs/SubmitPayoutApi.md#submit_payout) | **POST** /v3/payouts | Submit Payout
+*VeloPayments::WithdrawPayoutApi* | [**v3_payouts_payout_id_delete**](docs/WithdrawPayoutApi.md#v3_payouts_payout_id_delete) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout
+
+
+## Documentation for Models
+
+ - [VeloPayments::Address](docs/Address.md)
+ - [VeloPayments::Challenge](docs/Challenge.md)
+ - [VeloPayments::Company](docs/Company.md)
+ - [VeloPayments::CreatePayee](docs/CreatePayee.md)
+ - [VeloPayments::CreatePayeesCSVRequest](docs/CreatePayeesCSVRequest.md)
+ - [VeloPayments::CreatePayeesCSVResponse](docs/CreatePayeesCSVResponse.md)
+ - [VeloPayments::CreatePayeesRequest](docs/CreatePayeesRequest.md)
+ - [VeloPayments::CreatePaymentChannel](docs/CreatePaymentChannel.md)
+ - [VeloPayments::CreatePayoutRequest](docs/CreatePayoutRequest.md)
+ - [VeloPayments::FailedSubmission](docs/FailedSubmission.md)
+ - [VeloPayments::FundingAudit](docs/FundingAudit.md)
+ - [VeloPayments::FundingEvent](docs/FundingEvent.md)
+ - [VeloPayments::FundingEventType](docs/FundingEventType.md)
+ - [VeloPayments::FundingRequest](docs/FundingRequest.md)
+ - [VeloPayments::FundingRequest2](docs/FundingRequest2.md)
+ - [VeloPayments::FxSummary](docs/FxSummary.md)
+ - [VeloPayments::GetFundingsResponse](docs/GetFundingsResponse.md)
+ - [VeloPayments::GetPaymentsForPayoutResponse](docs/GetPaymentsForPayoutResponse.md)
+ - [VeloPayments::GetPaymentsForPayoutResponseLinks](docs/GetPaymentsForPayoutResponseLinks.md)
+ - [VeloPayments::GetPaymentsForPayoutResponsePage](docs/GetPaymentsForPayoutResponsePage.md)
+ - [VeloPayments::GetPaymentsForPayoutResponseSummary](docs/GetPaymentsForPayoutResponseSummary.md)
+ - [VeloPayments::GetPayoutStatistics](docs/GetPayoutStatistics.md)
+ - [VeloPayments::GetPayoutsResponse](docs/GetPayoutsResponse.md)
+ - [VeloPayments::Individual](docs/Individual.md)
+ - [VeloPayments::IndividualName](docs/IndividualName.md)
+ - [VeloPayments::InvitationStatusResponse](docs/InvitationStatusResponse.md)
+ - [VeloPayments::InvitePayeeRequest](docs/InvitePayeeRequest.md)
+ - [VeloPayments::Language](docs/Language.md)
+ - [VeloPayments::ListPaymentsResponse](docs/ListPaymentsResponse.md)
+ - [VeloPayments::ListSourceAccountResponse](docs/ListSourceAccountResponse.md)
+ - [VeloPayments::MarketingOptIn](docs/MarketingOptIn.md)
+ - [VeloPayments::OfacStatus](docs/OfacStatus.md)
+ - [VeloPayments::OnboardedStatus](docs/OnboardedStatus.md)
+ - [VeloPayments::PagedResponse](docs/PagedResponse.md)
+ - [VeloPayments::PagedResponsePage](docs/PagedResponsePage.md)
+ - [VeloPayments::Payee](docs/Payee.md)
+ - [VeloPayments::PayeeInvitationStatus](docs/PayeeInvitationStatus.md)
+ - [VeloPayments::PayeeResponse](docs/PayeeResponse.md)
+ - [VeloPayments::PayeeType](docs/PayeeType.md)
+ - [VeloPayments::PaymentAuditCurrency](docs/PaymentAuditCurrency.md)
+ - [VeloPayments::PaymentChannel](docs/PaymentChannel.md)
+ - [VeloPayments::PaymentChannelCountry](docs/PaymentChannelCountry.md)
+ - [VeloPayments::PaymentChannelRule](docs/PaymentChannelRule.md)
+ - [VeloPayments::PaymentChannelRulesResponse](docs/PaymentChannelRulesResponse.md)
+ - [VeloPayments::PaymentEventResponse](docs/PaymentEventResponse.md)
+ - [VeloPayments::PaymentInstruction](docs/PaymentInstruction.md)
+ - [VeloPayments::PaymentResponse](docs/PaymentResponse.md)
+ - [VeloPayments::Payor](docs/Payor.md)
+ - [VeloPayments::PayorBrandingResponse](docs/PayorBrandingResponse.md)
+ - [VeloPayments::PayorCreateApiKeyRequest](docs/PayorCreateApiKeyRequest.md)
+ - [VeloPayments::PayorCreateApiKeyResponse](docs/PayorCreateApiKeyResponse.md)
+ - [VeloPayments::PayorCreateApplicationRequest](docs/PayorCreateApplicationRequest.md)
+ - [VeloPayments::PayorEmailOptOutRequest](docs/PayorEmailOptOutRequest.md)
+ - [VeloPayments::PayorFundingBankDetailsUpdate](docs/PayorFundingBankDetailsUpdate.md)
+ - [VeloPayments::PayorLogoRequest](docs/PayorLogoRequest.md)
+ - [VeloPayments::PayorRef](docs/PayorRef.md)
+ - [VeloPayments::PayoutStatus](docs/PayoutStatus.md)
+ - [VeloPayments::PayoutSummaryAudit](docs/PayoutSummaryAudit.md)
+ - [VeloPayments::PayoutSummaryResponse](docs/PayoutSummaryResponse.md)
+ - [VeloPayments::QueryBatchResponse](docs/QueryBatchResponse.md)
+ - [VeloPayments::QuoteFxSummary](docs/QuoteFxSummary.md)
+ - [VeloPayments::QuoteResponse](docs/QuoteResponse.md)
+ - [VeloPayments::RejectedPayment](docs/RejectedPayment.md)
+ - [VeloPayments::Social](docs/Social.md)
+ - [VeloPayments::SourceAccount](docs/SourceAccount.md)
+ - [VeloPayments::SourceAccountResponse](docs/SourceAccountResponse.md)
+ - [VeloPayments::SourceAccountSummary](docs/SourceAccountSummary.md)
+ - [VeloPayments::SupportedCountriesResponse](docs/SupportedCountriesResponse.md)
+ - [VeloPayments::SupportedCountry](docs/SupportedCountry.md)
+ - [VeloPayments::SupportedCurrency](docs/SupportedCurrency.md)
+ - [VeloPayments::SupportedCurrencyResponse](docs/SupportedCurrencyResponse.md)
+
+
+## Documentation for Authorization
+
+
+### OAuth2
+
+
+- **Type**: OAuth
+- **Flow**: application
+- **Authorization URL**: 
+- **Scopes**: 
+  -  : Scopes not required
+