velopayments 2.11.73 → 2.14.90.pre.1

data/docs/PaymentInstruction.md

@@ -16,12 +16,12 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentInstruction.new(remote_id: null,
-                                 currency: null,
-                                 amount: null,
-                                 payment_memo: null,
-                                 source_account_name: null,
-                                 payor_payment_id: null)
+instance = VeloPayments::PaymentInstruction.new(remote_id: remoteId1234,
+                                 currency: USD,
+                                 amount: 1299,
+                                 payment_memo: my memo,
+                                 source_account_name: MyAccountName,
+                                 payor_payment_id: 123211321ABSD)
 ```
 
 

data/docs/PaymentResponseV3.md

@@ -0,0 +1,81 @@
+# VeloPayments::PaymentResponseV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** |  | 
+**payee_id** | **String** |  | 
+**payor_id** | **String** |  | 
+**payor_name** | **String** |  | [optional] 
+**quote_id** | **String** |  | 
+**source_account_id** | **String** |  | 
+**source_account_name** | **String** |  | [optional] 
+**remote_id** | **String** |  | [optional] 
+**source_amount** | **Integer** |  | [optional] 
+**source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**payment_amount** | **Integer** |  | 
+**payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**rate** | **Float** |  | [optional] 
+**inverted_rate** | **Float** |  | [optional] 
+**submitted_date_time** | **DateTime** |  | 
+**status** | **String** |  | 
+**funding_status** | **String** |  | 
+**routing_number** | **String** |  | [optional] 
+**account_number** | **String** |  | [optional] 
+**iban** | **String** |  | [optional] 
+**payment_memo** | **String** |  | [optional] 
+**filename_reference** | **String** |  | [optional] 
+**individual_identification_number** | **String** |  | [optional] 
+**trace_number** | **String** |  | [optional] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_channel_id** | **String** |  | [optional] 
+**payment_channel_name** | **String** |  | [optional] 
+**account_name** | **String** |  | [optional] 
+**rails_id** | **String** |  | 
+**country_code** | **String** |  | [optional] 
+**events** | [**Array<PaymentEventResponseV3>**](PaymentEventResponseV3.md) |  | 
+**return_cost** | **Integer** |  | [optional] 
+**return_reason** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentResponseV3.new(payment_id: null,
+                                 payee_id: null,
+                                 payor_id: null,
+                                 payor_name: null,
+                                 quote_id: null,
+                                 source_account_id: null,
+                                 source_account_name: My Account,
+                                 remote_id: aasdf123,
+                                 source_amount: 12345,
+                                 source_currency: null,
+                                 payment_amount: null,
+                                 payment_currency: null,
+                                 rate: null,
+                                 inverted_rate: null,
+                                 submitted_date_time: null,
+                                 status: null,
+                                 funding_status: null,
+                                 routing_number: 123123123123,
+                                 account_number: 123123232323,
+                                 iban: DE89 3704 0044 0532 0130 00,
+                                 payment_memo: Payment memo,
+                                 filename_reference: file ref,
+                                 individual_identification_number: 1231231adf,
+                                 trace_number: abodu123,
+                                 payor_payment_id: 123123asdf,
+                                 payment_channel_id: 123asdf,
+                                 payment_channel_name: My Payment Channel,
+                                 account_name: My Account Name,
+                                 rails_id: asdf123,
+                                 country_code: US,
+                                 events: null,
+                                 return_cost: 1232,
+                                 return_reason: Some Reason Value)
+```
+
+

data/docs/{PaymentResponse.md → PaymentResponseV4.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PaymentResponse
+# VeloPayments::PaymentResponseV4
 
 ## Properties
 
@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 **source_account_name** | **String** |  | [optional] 
 **remote_id** | **String** |  | [optional] 
 **source_amount** | **Integer** |  | [optional] 
-**source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**source_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
 **payment_amount** | **Integer** |  | 
-**payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**payment_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
 **rate** | **Float** |  | [optional] 
 **inverted_rate** | **Float** |  | [optional] 
 **submitted_date_time** | **DateTime** |  | 
@@ -34,7 +34,7 @@ Name | Type | Description | Notes
 **account_name** | **String** |  | [optional] 
 **rails_id** | **String** |  | 
 **country_code** | **String** |  | [optional] 
-**events** | [**Array<PaymentEventResponse>**](PaymentEventResponse.md) |  | 
+**events** | [**Array<PaymentEventResponseV4>**](PaymentEventResponseV4.md) |  | 
 **return_cost** | **Integer** |  | [optional] 
 **return_reason** | **String** |  | [optional] 
 
@@ -43,7 +43,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentResponse.new(payment_id: null,
+instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  payee_id: null,
                                  payor_id: null,
                                  payor_name: null,

data/docs/PayorApplicationsApi.md

@@ -71,7 +71,7 @@ Name | Type | Description  | Notes
 
 Create Application
 
-Create an application for the given Payor ID
+Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
 
 ### Example
 

data/docs/PayorBrandingResponse.md

@@ -15,11 +15,11 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorBrandingResponse.new(payor_name: null,
-                                 logo_url: null,
-                                 collective_alias: null,
-                                 support_contact: null,
-                                 dba_name: null)
+instance = VeloPayments::PayorBrandingResponse.new(payor_name: Key West Imports, Inc,
+                                 logo_url: example.com,
+                                 collective_alias: Payee,
+                                 support_contact: support@example.com,
+                                 dba_name: Key West Imports)
 ```
 
 

data/docs/PayorCreateApiKeyRequest.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorCreateApiKeyRequest.new(name: null,
-                                 description: null,
-                                 roles: null)
+instance = VeloPayments::PayorCreateApiKeyRequest.new(name: iOS Key,
+                                 description: Key for iOS mobile application,
+                                 roles: ["payor.admin"])
 ```
 
 

data/docs/PayorCreateApiKeyResponse.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorCreateApiKeyResponse.new(api_key: null,
-                                 api_secret: null)
+instance = VeloPayments::PayorCreateApiKeyResponse.new(api_key: 385d4506-e7dd-446e-a092-5f30b98e7b26,
+                                 api_secret: f25767d9-342a-48ac-a788-0a7a38ae6fb3)
 ```
 
 

data/docs/PayorCreateApplicationRequest.md

@@ -12,8 +12,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorCreateApplicationRequest.new(name: null,
-                                 description: null)
+instance = VeloPayments::PayorCreateApplicationRequest.new(name: SAP,
+                                 description: SAP Application integration)
 ```
 
 

data/docs/PayorEmailOptOutRequest.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**reminder_emails_opt_out** | **Boolean** |  | [optional] 
+**reminder_emails_opt_out** | **Boolean** |  | 
 
 ## Code Sample
 

data/docs/PayorFundingBankDetailsUpdate.md

@@ -13,9 +13,9 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorFundingBankDetailsUpdate.new(routing_number: null,
-                                 account_number: null,
-                                 account_name: null)
+instance = VeloPayments::PayorFundingBankDetailsUpdate.new(routing_number: 123123123,
+                                 account_number: 123456789012345,
+                                 account_name: Bank of America)
 ```
 
 

data/docs/PayorLinksResponse.md

@@ -0,0 +1,19 @@
+# VeloPayments::PayorLinksResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**links** | [**Array<PayorLinksResponseLinks>**](PayorLinksResponseLinks.md) |  | [optional] 
+**payors** | [**Array<PayorLinksResponsePayors>**](PayorLinksResponsePayors.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorLinksResponse.new(links: null,
+                                 payors: null)
+```
+
+

data/docs/PayorLinksResponseLinks.md

@@ -0,0 +1,23 @@
+# VeloPayments::PayorLinksResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**link_id** | **String** |  | 
+**from_payor_id** | **String** |  | 
+**link_type** | **String** |  | 
+**to_payor_id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorLinksResponseLinks.new(link_id: null,
+                                 from_payor_id: null,
+                                 link_type: null,
+                                 to_payor_id: null)
+```
+
+

data/docs/PayorLinksResponsePayors.md

@@ -0,0 +1,23 @@
+# VeloPayments::PayorLinksResponsePayors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | 
+**payor_name** | **String** |  | 
+**primary_contact_email** | **String** |  | [optional] 
+**kyc_state** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorLinksResponsePayors.new(payor_id: null,
+                                 payor_name: null,
+                                 primary_contact_email: null,
+                                 kyc_state: null)
+```
+
+

data/docs/PayorRef.md

@@ -13,8 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayorRef.new(payor_id: null,
-                                 remote_id: null,
+instance = VeloPayments::PayorRef.new(payor_id: ba08877f-9d96-41e4-9c26-44a872d856ae,
+                                 remote_id: uniqueIdForRemoteEntity,
                                  invitation_status: null)
 ```
 

data/docs/{Payor.md → PayorV1.md}

@@ -1,4 +1,4 @@
-# VeloPayments::Payor
+# VeloPayments::PayorV1
 
 ## Properties
 
@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] 
 **payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] 
 **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] 
-**support_contact** | **String** | The payor’s support contact address. | [optional] 
+**support_contact** | **String** | The payor’s support contact email address. | [optional] 
 **dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] 
 **allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] 
 **reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] 
@@ -30,25 +30,25 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::Payor.new(payor_id: null,
-                                 payor_name: null,
+instance = VeloPayments::PayorV1.new(payor_id: null,
+                                 payor_name: Example, Corp,
                                  address: null,
-                                 primary_contact_name: null,
-                                 primary_contact_phone: null,
-                                 primary_contact_email: null,
-                                 funding_account_routing_number: null,
-                                 funding_account_account_number: null,
-                                 funding_account_account_name: null,
-                                 kyc_state: null,
+                                 primary_contact_name: Joe Buck,
+                                 primary_contact_phone: 123-123-1234,
+                                 primary_contact_email: joe.buck@example.com,
+                                 funding_account_routing_number: 123456789,
+                                 funding_account_account_number: 1234567890123,
+                                 funding_account_account_name: Example Corp BOA,
+                                 kyc_state: PASSED_KYC,
                                  manual_lockout: null,
                                  payee_grace_period_processing_enabled: null,
                                  payee_grace_period_days: null,
-                                 collective_alias: null,
-                                 support_contact: null,
-                                 dba_name: null,
+                                 collective_alias: Payee,
+                                 support_contact: support@example.com,
+                                 dba_name: Some Biz,
                                  allows_language_choice: null,
                                  reminder_emails_opt_out: null,
-                                 language: null,
+                                 language: EN,
                                  includes_reports: null)
 ```
 

data/docs/PayorV2.md

@@ -0,0 +1,49 @@
+# VeloPayments::PayorV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | [optional] 
+**payor_name** | **String** | The name of the payor. | 
+**address** | [**Address**](Address.md) |  | [optional] 
+**primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] 
+**primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] 
+**primary_contact_email** | **String** | Primary contact email for the payor. | [optional] 
+**kyc_state** | **String** | The kyc state of the payor. | [optional] 
+**manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] 
+**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] 
+**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] 
+**collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] 
+**support_contact** | **String** | The payor’s support contact email address. | [optional] 
+**dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] 
+**allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] 
+**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] 
+**language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
+**includes_reports** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorV2.new(payor_id: null,
+                                 payor_name: Example, Corp,
+                                 address: null,
+                                 primary_contact_name: Joe Buck,
+                                 primary_contact_phone: 123-123-1234,
+                                 primary_contact_email: joe.buck@example.com,
+                                 kyc_state: PASSED_KYC,
+                                 manual_lockout: null,
+                                 payee_grace_period_processing_enabled: null,
+                                 payee_grace_period_days: null,
+                                 collective_alias: Payee,
+                                 support_contact: support@example.com,
+                                 dba_name: Some Biz,
+                                 allows_language_choice: null,
+                                 reminder_emails_opt_out: null,
+                                 language: EN,
+                                 includes_reports: null)
+```
+
+

data/docs/PayorsApi.md

@@ -5,19 +5,21 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor
+[**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor
 [**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo
 [**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out
 [**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding
+[**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links
 
 
 
 ## get_payor_by_id
 
-> Payor get_payor_by_id(payor_id)
+> PayorV1 get_payor_by_id(payor_id)
 
 Get Payor
 
-Get a Single Payor by Id (200 - OK, 404 - payor not found). 
+Get a Single Payor by Id. 
 
 ### Example
 
@@ -51,7 +53,59 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**Payor**](Payor.md)
+[**PayorV1**](PayorV1.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payor_by_id_v2
+
+> PayorV2 get_payor_by_id_v2(payor_id)
+
+Get Payor
+
+Get a Single Payor by Id. 
+
+### 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::PayorsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+
+begin
+  #Get Payor
+  result = api_instance.get_payor_by_id_v2(payor_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->get_payor_by_id_v2: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+
+### Return type
+
+[**PayorV2**](PayorV2.md)
 
 ### Authorization
 
@@ -69,7 +123,7 @@ Name | Type | Description  | Notes
 
 Add Logo
 
-Add Payor Logo
+Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
 
 ### Example
 
@@ -139,7 +193,7 @@ end
 
 api_instance = VeloPayments::PayorsApi.new
 payor_id = 'payor_id_example' # String | The account owner Payor ID
-payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new # PayorEmailOptOutRequest | Details of application API key to create
+payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
 
 begin
   #Reminder Email Opt-Out
@@ -155,7 +209,7 @@ end
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **payor_id** | [**String**](.md)| The account owner Payor ID | 
- **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md)| Details of application API key to create | 
+ **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md)| Reminder Emails Opt-Out Request | 
 
 ### Return type
 
@@ -222,3 +276,59 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## payor_links
+
+> PayorLinksResponse payor_links(descendants_of_payor, opts)
+
+List Payor Links
+
+This endpoint allows you to list payor links
+
+### 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::PayorsApi.new
+descendants_of_payor = 'descendants_of_payor_example' # String | The Payor ID from which to start the query to show all descendants
+opts = {
+  fields: 'fields_example' # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState              
+}
+
+begin
+  #List Payor Links
+  result = api_instance.payor_links(descendants_of_payor, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorsApi->payor_links: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **descendants_of_payor** | [**String**](.md)| The Payor ID from which to start the query to show all descendants | 
+ **fields** | **String**| List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState               | [optional] 
+
+### Return type
+
+[**PayorLinksResponse**](PayorLinksResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+