velopayments 2.29.128.beta1 → 2.35.58.beta1

data/docs/FundingApi.md

@@ -0,0 +1,459 @@
+# VeloPayments::FundingApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_funding_request_v2**](FundingApi.md#create_funding_request_v2) | **POST** /v2/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request |
+| [**create_funding_request_v3**](FundingApi.md#create_funding_request_v3) | **POST** /v3/sourceAccounts/{sourceAccountId}/fundingRequest | Create Funding Request |
+| [**get_funding_account_v2**](FundingApi.md#get_funding_account_v2) | **GET** /v2/fundingAccounts/{fundingAccountId} | Get Funding Account |
+| [**get_funding_accounts_v2**](FundingApi.md#get_funding_accounts_v2) | **GET** /v2/fundingAccounts | Get Funding Accounts |
+| [**get_funding_by_id_v1**](FundingApi.md#get_funding_by_id_v1) | **GET** /v1/fundings/{fundingId} | Get Funding |
+| [**list_funding_audit_deltas**](FundingApi.md#list_funding_audit_deltas) | **GET** /v1/deltas/fundings | Get Funding Audit Delta |
+
+
+## create_funding_request_v2
+
+> create_funding_request_v2(source_account_id, funding_request_v2)
+
+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).
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+source_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Source account id
+funding_request_v2 = VeloPayments::FundingRequestV2.new({amount: 3.56}) # FundingRequestV2 | Body to included amount to be funded
+
+begin
+  # Create Funding Request
+  api_instance.create_funding_request_v2(source_account_id, funding_request_v2)
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->create_funding_request_v2: #{e}"
+end
+```
+
+#### Using the create_funding_request_v2_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> create_funding_request_v2_with_http_info(source_account_id, funding_request_v2)
+
+```ruby
+begin
+  # Create Funding Request
+  data, status_code, headers = api_instance.create_funding_request_v2_with_http_info(source_account_id, funding_request_v2)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->create_funding_request_v2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_account_id** | **String** | Source account id |  |
+| **funding_request_v2** | [**FundingRequestV2**](FundingRequestV2.md) | Body to included amount to be funded |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_funding_request_v3
+
+> create_funding_request_v3(source_account_id, funding_request_v3)
+
+Create Funding Request
+
+<p>Instruct a funding request to transfer funds from the payor’s funding bank to the payor’s balance held within Velo</p> 
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+source_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Source account id
+funding_request_v3 = VeloPayments::FundingRequestV3.new({funding_account_id: 'funding_account_id_example', amount: 3.56}) # FundingRequestV3 | Body to included amount to be funded
+
+begin
+  # Create Funding Request
+  api_instance.create_funding_request_v3(source_account_id, funding_request_v3)
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->create_funding_request_v3: #{e}"
+end
+```
+
+#### Using the create_funding_request_v3_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> create_funding_request_v3_with_http_info(source_account_id, funding_request_v3)
+
+```ruby
+begin
+  # Create Funding Request
+  data, status_code, headers = api_instance.create_funding_request_v3_with_http_info(source_account_id, funding_request_v3)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->create_funding_request_v3_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_account_id** | **String** | Source account id |  |
+| **funding_request_v3** | [**FundingRequestV3**](FundingRequestV3.md) | Body to included amount to be funded |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_funding_account_v2
+
+> <FundingAccountResponseV2> get_funding_account_v2(funding_account_id, opts)
+
+Get Funding Account
+
+Get Funding Account by ID
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+funding_account_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+opts = {
+  sensitive: true # Boolean | 
+}
+
+begin
+  # Get Funding Account
+  result = api_instance.get_funding_account_v2(funding_account_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_account_v2: #{e}"
+end
+```
+
+#### Using the get_funding_account_v2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FundingAccountResponseV2>, Integer, Hash)> get_funding_account_v2_with_http_info(funding_account_id, opts)
+
+```ruby
+begin
+  # Get Funding Account
+  data, status_code, headers = api_instance.get_funding_account_v2_with_http_info(funding_account_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FundingAccountResponseV2>
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_account_v2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **funding_account_id** | **String** |  |  |
+| **sensitive** | **Boolean** |  | [optional][default to false] |
+
+### Return type
+
+[**FundingAccountResponseV2**](FundingAccountResponseV2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_funding_accounts_v2
+
+> <ListFundingAccountsResponseV2> get_funding_accounts_v2(opts)
+
+Get Funding Accounts
+
+Get the funding accounts.
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+opts = {
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | 
+  name: 'name_example', # String | The descriptive funding account name
+  country: 'US', # String | The 2 letter ISO 3166-1 country code (upper case)
+  currency: 'USD', # String | The ISO 4217 currency code
+  type: 'type_example', # String | The type of funding account.
+  page: 56, # Integer | Page number. Default is 1.
+  page_size: 56, # Integer | The number of results to return in a page
+  sort: 'sort_example', # String | List of sort fields (e.g. ?sort=accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name.
+  sensitive: true # Boolean | 
+}
+
+begin
+  # Get Funding Accounts
+  result = api_instance.get_funding_accounts_v2(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_accounts_v2: #{e}"
+end
+```
+
+#### Using the get_funding_accounts_v2_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListFundingAccountsResponseV2>, Integer, Hash)> get_funding_accounts_v2_with_http_info(opts)
+
+```ruby
+begin
+  # Get Funding Accounts
+  data, status_code, headers = api_instance.get_funding_accounts_v2_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListFundingAccountsResponseV2>
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_accounts_v2_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payor_id** | **String** |  | [optional] |
+| **name** | **String** | The descriptive funding account name | [optional] |
+| **country** | **String** | The 2 letter ISO 3166-1 country code (upper case) | [optional] |
+| **currency** | **String** | The ISO 4217 currency code | [optional] |
+| **type** | **String** | The type of funding account. | [optional] |
+| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
+| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
+| **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;accountName:asc,name:asc) Default is accountName:asc The supported sort fields are - accountName, name. | [optional][default to &#39;accountName:asc&#39;] |
+| **sensitive** | **Boolean** |  | [optional][default to false] |
+
+### Return type
+
+[**ListFundingAccountsResponseV2**](ListFundingAccountsResponseV2.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_funding_by_id_v1
+
+> <FundingResponse> get_funding_by_id_v1(funding_id)
+
+Get Funding
+
+Get Funding by Id
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+funding_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get Funding
+  result = api_instance.get_funding_by_id_v1(funding_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_by_id_v1: #{e}"
+end
+```
+
+#### Using the get_funding_by_id_v1_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FundingResponse>, Integer, Hash)> get_funding_by_id_v1_with_http_info(funding_id)
+
+```ruby
+begin
+  # Get Funding
+  data, status_code, headers = api_instance.get_funding_by_id_v1_with_http_info(funding_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FundingResponse>
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->get_funding_by_id_v1_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **funding_id** | **String** |  |  |
+
+### Return type
+
+[**FundingResponse**](FundingResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_funding_audit_deltas
+
+> <PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse> list_funding_audit_deltas(payor_id, updated_since, opts)
+
+Get Funding Audit Delta
+
+Get funding audit deltas for a payor
+
+### Examples
+
+```ruby
+require 'time'
+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::FundingApi.new
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | 
+opts = {
+  page: 56, # Integer | Page number. Default is 1.
+  page_size: 56 # Integer | The number of results to return in a page
+}
+
+begin
+  # Get Funding Audit Delta
+  result = api_instance.list_funding_audit_deltas(payor_id, updated_since, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->list_funding_audit_deltas: #{e}"
+end
+```
+
+#### Using the list_funding_audit_deltas_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse>, Integer, Hash)> list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts)
+
+```ruby
+begin
+  # Get Funding Audit Delta
+  data, status_code, headers = api_instance.list_funding_audit_deltas_with_http_info(payor_id, updated_since, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse>
+rescue VeloPayments::ApiError => e
+  puts "Error when calling FundingApi->list_funding_audit_deltas_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payor_id** | **String** |  |  |
+| **updated_since** | **Time** |  |  |
+| **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
+| **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
+
+### Return type
+
+[**PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse**](PageResourceFundingPayorStatusAuditResponseFundingPayorStatusAuditResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FundingAudit.md

@@ -7,12 +7,12 @@
 | **amount** | **Float** | The amount funded | [optional] |
 | **currency** | **String** | The currency of the funding | [optional] |
 | **date_time** | **Time** |  | [optional] |
-| **status** | **String** |  | [optional] |
+| **status** | **String** | Status of the funding. One of the following values: PENDING, FAILED, CREDIT, DEBIT | [optional] |
 | **source_account_name** | **String** |  | [optional] |
 | **funding_account_name** | **String** |  | [optional] |
-| **funding_type** | **String** |  | [optional] |
+| **funding_type** | **String** | Funding type. One of the following values: ACH, WIRE, EMBEDDED, BANK_TRANSFER | [optional] |
 | **events** | [**Array<FundingEvent>**](FundingEvent.md) |  | [optional] |
-| **topup_type** | **String** |  | [optional] |
+| **topup_type** | **String** | Type of top up. One of the following values: AUTOMATIC, MANUAL | [optional] |
 
 ## Example
 

data/docs/FundingEvent.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **event_id** | **String** |  | [optional] |
 | **event_date_time** | **Time** |  | [optional] |
-| **funding_event_type** | [**FundingEventType**](FundingEventType.md) |  | [optional] |
+| **funding_event_type** | **String** | Funding event type. One of the following values: PAYOR_FUNDING_DETECTED, PAYOR_FUNDING_REQUESTED, PAYOR_FUNDING_RETURN_RECEIVED, FUNDING_RETURN_DETECTED, PAYOR_FUNDING_REQUEST_SUBMITTED, PAYOR_FUNDING_ENTRY_DETAIL_RECEIVED, FUNDING_DEALLOCATED | [optional] |
 | **principal** | **String** |  | [optional] |
 
 ## Example

data/docs/FundingResponse.md

@@ -0,0 +1,44 @@
+# VeloPayments::FundingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **funding_id** | **String** |  |  |
+| **payor_id** | **String** |  |  |
+| **allocation_date** | **Time** |  |  |
+| **detected_funding_ref** | **String** |  | [optional] |
+| **amount** | **Integer** |  |  |
+| **currency** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. |  |
+| **text** | **String** |  | [optional] |
+| **physical_account_name** | **String** |  | [optional] |
+| **source_account_id** | **String** |  | [optional] |
+| **allocation_type** | **String** | Funding Allocation Type. One of the following values: AUTOMATIC, MANUAL | [optional] |
+| **reason** | **String** |  | [optional] |
+| **hidden_date** | **Time** |  | [optional] |
+| **funding_account_type** | **String** | Funding Account Type. One of the following values: FBO, WUBS_DECOUPLED, PRIVATE |  |
+| **status** | **String** | Current status of the funding. One of the follwing values: PENDING, UNALLOCATED, ALLOCATED, HIDDEN, RETURNED, RETURNING, BULK_RETURN, OTHER |  |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::FundingResponse.new(
+  funding_id: null,
+  payor_id: null,
+  allocation_date: null,
+  detected_funding_ref: null,
+  amount: null,
+  currency: USD,
+  text: null,
+  physical_account_name: null,
+  source_account_id: null,
+  allocation_type: null,
+  reason: null,
+  hidden_date: null,
+  funding_account_type: FBO,
+  status: ALLOCATED
+)
+```
+

data/docs/FxSummary.md

@@ -10,10 +10,10 @@
 | **inverted_rate** | **Float** |  |  |
 | **total_cost** | **Integer** |  |  |
 | **total_payment_amount** | **Integer** |  |  |
-| **source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] |
-| **payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] |
-| **status** | **String** |  |  |
-| **funding_status** | **String** |  |  |
+| **source_currency** | **String** | ISO-4217 3 character currency code | [optional] |
+| **payment_currency** | **String** | ISO-4217 3 character currency code | [optional] |
+| **status** | **String** | Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED |  |
+| **funding_status** | **String** | Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED |  |
 
 ## Example
 
@@ -27,8 +27,8 @@ instance = VeloPayments::FxSummary.new(
   inverted_rate: 123.23,
   total_cost: null,
   total_payment_amount: 34235,
-  source_currency: null,
-  payment_currency: null,
+  source_currency: EUR,
+  payment_currency: EUR,
   status: null,
   funding_status: null
 )

data/docs/FxSummaryV3.md

@@ -10,10 +10,10 @@
 | **inverted_rate** | **Float** |  |  |
 | **total_cost** | **Integer** |  |  |
 | **total_payment_amount** | **Integer** |  |  |
-| **source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] |
-| **payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] |
-| **status** | **String** |  |  |
-| **funding_status** | **String** |  |  |
+| **source_currency** | **String** | ISO 3 character currency code | [optional] |
+| **payment_currency** | **String** | ISO 3 character currency code | [optional] |
+| **status** | **String** | Current status of the FX Summary. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED |  |
+| **funding_status** | **String** | Current status of the funding. One of the following values: FUNDED, INSTRUCTED, UNFUNDED |  |
 
 ## Example
 

data/docs/{GetPayeeListResponseCompany.md → GetPayeeListResponseCompanyV3.md}

@@ -1,4 +1,4 @@
-# VeloPayments::GetPayeeListResponseCompany
+# VeloPayments::GetPayeeListResponseCompanyV3
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::GetPayeeListResponseCompany.new(
+instance = VeloPayments::GetPayeeListResponseCompanyV3.new(
   name: ABC Group Plc,
   operating_name: ABC Co
 )

data/docs/{GetPayeeListResponseCompany2.md → GetPayeeListResponseCompanyV4.md}

@@ -1,4 +1,4 @@
-# VeloPayments::GetPayeeListResponseCompany2
+# VeloPayments::GetPayeeListResponseCompanyV4
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::GetPayeeListResponseCompany2.new(
+instance = VeloPayments::GetPayeeListResponseCompanyV4.new(
   name: ABC Group Plc,
   operating_name: ABC Co
 )

data/docs/GetPayeeListResponseIndividualV3.md

@@ -0,0 +1,18 @@
+# VeloPayments::GetPayeeListResponseIndividualV3
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**NameV3**](NameV3.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::GetPayeeListResponseIndividualV3.new(
+  name: null
+)
+```
+

data/docs/GetPayeeListResponseIndividualV4.md

@@ -0,0 +1,18 @@
+# VeloPayments::GetPayeeListResponseIndividualV4
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | [**NameV4**](NameV4.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::GetPayeeListResponseIndividualV4.new(
+  name: null
+)
+```
+

data/docs/{GetPayeeListResponse.md → GetPayeeListResponseV3.md}

@@ -1,4 +1,4 @@
-# VeloPayments::GetPayeeListResponse
+# VeloPayments::GetPayeeListResponseV3
 
 ## Properties
 
@@ -7,27 +7,27 @@
 | **payee_id** | **String** |  | [optional][readonly] |
 | **payor_refs** | [**Array<PayeePayorRefV3>**](PayeePayorRefV3.md) |  | [optional][readonly] |
 | **email** | **String** |  | [optional] |
-| **onboarded_status** | [**OnboardedStatus2**](OnboardedStatus2.md) |  | [optional] |
-| **watchlist_status** | [**WatchlistStatus**](WatchlistStatus.md) |  | [optional] |
+| **onboarded_status** | **String** | Onboarded status. One of the following values: CREATED, INVITED, REGISTERED, ONBOARDED | [optional] |
+| **watchlist_status** | **String** | Current watchlist status. One of the following values: NONE, PENDING, REVIEW, PASSED, FAILED | [optional] |
 | **watchlist_status_updated_timestamp** | **String** |  | [optional][readonly] |
 | **watchlist_override_comment** | **String** |  | [optional] |
 | **language** | **String** | An IETF BCP 47 language code which has been configured for use within this Velo environment.<BR> See the /v1/supportedLanguages endpoint to list the available codes for an environment.  | [optional] |
 | **created** | **Time** |  | [optional] |
-| **country** | **String** |  | [optional] |
+| **country** | **String** | Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details. | [optional] |
 | **display_name** | **String** |  | [optional] |
-| **payee_type** | [**PayeeType2**](PayeeType2.md) |  | [optional] |
+| **payee_type** | **String** | Type of Payee. One of the following values: Individual, Company | [optional] |
 | **disabled** | **Boolean** |  | [optional] |
 | **disabled_comment** | **String** |  | [optional] |
 | **disabled_updated_timestamp** | **Time** |  | [optional] |
-| **individual** | [**GetPayeeListResponseIndividual**](GetPayeeListResponseIndividual.md) |  | [optional] |
-| **company** | [**GetPayeeListResponseCompany**](GetPayeeListResponseCompany.md) |  | [optional] |
+| **individual** | [**GetPayeeListResponseIndividualV3**](GetPayeeListResponseIndividualV3.md) |  | [optional] |
+| **company** | [**GetPayeeListResponseCompanyV3**](GetPayeeListResponseCompanyV3.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::GetPayeeListResponse.new(
+instance = VeloPayments::GetPayeeListResponseV3.new(
   payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
   payor_refs: null,
   email: bob@example.com,