velopayments 2.11.73

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/docs/Address.md

@@ -0,0 +1,31 @@
+# VeloPayments::Address
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**line1** | **String** |  | 
+**line2** | **String** |  | [optional] 
+**line3** | **String** |  | [optional] 
+**line4** | **String** |  | [optional] 
+**city** | **String** |  | 
+**county_or_province** | **String** |  | [optional] 
+**zip_or_postcode** | **String** |  | [optional] 
+**country** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Address.new(line1: null,
+                                 line2: null,
+                                 line3: null,
+                                 line4: null,
+                                 city: null,
+                                 county_or_province: null,
+                                 zip_or_postcode: null,
+                                 country: null)
+```
+
+

data/docs/Challenge.md

@@ -0,0 +1,19 @@
+# VeloPayments::Challenge
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**value** | **String** |  | 
+**description** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Challenge.new(value: null,
+                                 description: null)
+```
+
+

data/docs/Company.md

@@ -0,0 +1,19 @@
+# VeloPayments::Company
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | 
+**tax_id** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Company.new(name: null,
+                                 tax_id: null)
+```
+
+

data/docs/CountriesApi.md

@@ -0,0 +1,106 @@
+# VeloPayments::CountriesApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_supported_countries**](CountriesApi.md#list_supported_countries) | **GET** /v1/supportedCountries | List Supported Countries
+[**v1_payment_channel_rules_get**](CountriesApi.md#v1_payment_channel_rules_get) | **GET** /v1/paymentChannelRules | List Payment Channel Country Rules
+
+
+
+## list_supported_countries
+
+> SupportedCountriesResponse list_supported_countries
+
+List Supported Countries
+
+List the supported countries.
+
+### 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::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
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SupportedCountriesResponse**](SupportedCountriesResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## v1_payment_channel_rules_get
+
+> PaymentChannelRulesResponse v1_payment_channel_rules_get
+
+List Payment Channel Country Rules
+
+List the country specific payment channel rules.
+
+### 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::CountriesApi.new
+
+begin
+  #List Payment Channel Country Rules
+  result = api_instance.v1_payment_channel_rules_get
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling CountriesApi->v1_payment_channel_rules_get: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PaymentChannelRulesResponse**](PaymentChannelRulesResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/CreatePayee.md

@@ -0,0 +1,59 @@
+# VeloPayments::CreatePayee
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | [optional] 
+**payor_refs** | [**Array<PayorRef>**](PayorRef.md) |  | [optional] 
+**email** | **String** |  | 
+**remote_id** | **String** |  | 
+**type** | [**PayeeType**](PayeeType.md) |  | 
+**display_name** | **String** |  | [optional] 
+**country** | **String** |  | [optional] 
+**address** | [**Address**](Address.md) |  | 
+**payment_channel** | [**CreatePaymentChannel**](CreatePaymentChannel.md) |  | [optional] 
+**challenge** | [**Challenge**](Challenge.md) |  | [optional] 
+**language** | [**Language**](Language.md) |  | [optional] 
+**accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional] 
+**cellphone_number** | **String** |  | [optional] 
+**company** | [**Company**](Company.md) |  | [optional] 
+**individual** | [**Individual**](Individual.md) |  | [optional] 
+**created** | **DateTime** |  | [optional] 
+**grace_period_end_date** | **Date** |  | [optional] 
+**last_ofac_check_timestamp** | **String** |  | [optional] 
+**marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) |  | [optional] 
+**ofac_status** | [**OfacStatus**](OfacStatus.md) |  | [optional] 
+**onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional] 
+**social** | [**Social**](Social.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayee.new(payee_id: null,
+                                 payor_refs: null,
+                                 email: null,
+                                 remote_id: null,
+                                 type: null,
+                                 display_name: null,
+                                 country: null,
+                                 address: null,
+                                 payment_channel: null,
+                                 challenge: null,
+                                 language: null,
+                                 accept_terms_and_conditions_timestamp: null,
+                                 cellphone_number: null,
+                                 company: null,
+                                 individual: null,
+                                 created: null,
+                                 grace_period_end_date: null,
+                                 last_ofac_check_timestamp: null,
+                                 marketing_opt_ins: null,
+                                 ofac_status: null,
+                                 onboarded_status: null,
+                                 social: null)
+```
+
+

data/docs/CreatePayeesCSVRequest.md

@@ -0,0 +1,71 @@
+# VeloPayments::CreatePayeesCSVRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**type** | [**PayeeType**](PayeeType.md) |  | 
+**remote_id** | **String** |  | 
+**email** | **String** |  | 
+**address_line1** | **String** |  | 
+**address_line2** | **String** |  | [optional] 
+**address_line3** | **String** |  | [optional] 
+**address_line4** | **String** |  | [optional] 
+**address_city** | **String** |  | 
+**address_county_or_province** | **String** |  | [optional] 
+**address_zip_or_postcode** | **String** |  | 
+**address_country** | **String** |  | 
+**individual_title** | **String** |  | [optional] 
+**individual_first_name** | **String** |  | [optional] 
+**individual_other_names** | **String** |  | [optional] 
+**individual_last_name** | **String** |  | [optional] 
+**individual_national_identification** | **String** |  | [optional] 
+**individual_date_of_birth** | **Date** | example - 1970-05-20 | [optional] 
+**company_name** | **String** |  | [optional] 
+**company_tax_id** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional] 
+**payment_channel_iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional] 
+**payment_channel_account_number** | **String** |  | [optional] 
+**payment_channel_routing_no** | **String** |  | [optional] 
+**payment_channel_country_code** | **String** | Must be a 3 character currency code. ISO 4217 | [optional] 
+**payment_channel_currency** | **String** |  | [optional] 
+**payment_channel_account_name** | **String** |  | [optional] 
+**challenge_value** | **String** |  | [optional] 
+**challenge_description** | **String** |  | [optional] 
+**payee_language** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayeesCSVRequest.new(type: null,
+                                 remote_id: null,
+                                 email: null,
+                                 address_line1: null,
+                                 address_line2: null,
+                                 address_line3: null,
+                                 address_line4: null,
+                                 address_city: null,
+                                 address_county_or_province: null,
+                                 address_zip_or_postcode: null,
+                                 address_country: null,
+                                 individual_title: null,
+                                 individual_first_name: null,
+                                 individual_other_names: null,
+                                 individual_last_name: null,
+                                 individual_national_identification: null,
+                                 individual_date_of_birth: null,
+                                 company_name: null,
+                                 company_tax_id: null,
+                                 payment_channel_iban: null,
+                                 payment_channel_account_number: null,
+                                 payment_channel_routing_no: null,
+                                 payment_channel_country_code: null,
+                                 payment_channel_currency: null,
+                                 payment_channel_account_name: null,
+                                 challenge_value: null,
+                                 challenge_description: null,
+                                 payee_language: null)
+```
+
+

data/docs/CreatePayeesCSVResponse.md

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

data/docs/CreatePayeesRequest.md

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

data/docs/CreatePaymentChannel.md

@@ -0,0 +1,29 @@
+# VeloPayments::CreatePaymentChannel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_channel_name** | **String** |  | [optional] 
+**iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. Either routing number and account number or only iban must be set | [optional] 
+**account_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**routing_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**country_code** | **String** | Two character country code | 
+**currency** | **String** |  | 
+**account_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePaymentChannel.new(payment_channel_name: null,
+                                 iban: null,
+                                 account_number: null,
+                                 routing_number: null,
+                                 country_code: null,
+                                 currency: null,
+                                 account_name: null)
+```
+
+

data/docs/CreatePayoutRequest.md

@@ -0,0 +1,21 @@
+# VeloPayments::CreatePayoutRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | 
+**payout_memo** | **String** |  | [optional] 
+**payments** | [**Array<PaymentInstruction>**](PaymentInstruction.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayoutRequest.new(payor_id: null,
+                                 payout_memo: null,
+                                 payments: null)
+```
+
+

data/docs/CurrenciesApi.md

@@ -0,0 +1,57 @@
+# VeloPayments::CurrenciesApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**list_supported_currencies**](CurrenciesApi.md#list_supported_currencies) | **GET** /v2/currencies | List Supported Currencies
+
+
+
+## list_supported_currencies
+
+> SupportedCurrencyResponse list_supported_currencies
+
+List Supported Currencies
+
+List the supported currencies.
+
+### 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::CurrenciesApi.new
+
+begin
+  #List Supported Currencies
+  result = api_instance.list_supported_currencies
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling CurrenciesApi->list_supported_currencies: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**SupportedCurrencyResponse**](SupportedCurrencyResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+