velopayments 2.14.90.pre.1 → 2.17.8.beta1

data/docs/FundingEvent.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **event_id** | **String** |  | [optional] 
 **event_date_time** | **DateTime** |  | [optional] 
 **funding_event_type** | [**FundingEventType**](FundingEventType.md) |  | [optional] 
+**principal** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -15,7 +16,8 @@ require 'VeloPayments'
 
 instance = VeloPayments::FundingEvent.new(event_id: null,
                                  event_date_time: null,
-                                 funding_event_type: null)
+                                 funding_event_type: null,
+                                 principal: null)
 ```
 
 

data/docs/FundingManagerApi.md

@@ -11,8 +11,8 @@ Method | HTTP request | Description
 [**get_source_account_v2**](FundingManagerApi.md#get_source_account_v2) | **GET** /v2/sourceAccounts/{sourceAccountId} | Get details about given source account.
 [**get_source_accounts**](FundingManagerApi.md#get_source_accounts) | **GET** /v1/sourceAccounts | Get list of source accounts
 [**get_source_accounts_v2**](FundingManagerApi.md#get_source_accounts_v2) | **GET** /v2/sourceAccounts | Get list of source accounts
+[**list_funding_audit_deltas**](FundingManagerApi.md#list_funding_audit_deltas) | **GET** /v1/deltas/fundings | List Funding changes
 [**set_notifications_request**](FundingManagerApi.md#set_notifications_request) | **POST** /v1/sourceAccounts/{sourceAccountId}/notifications | Set notifications
-[**set_payor_funding_bank_details**](FundingManagerApi.md#set_payor_funding_bank_details) | **POST** /v1/payors/{payorId}/payorFundingBankDetailsUpdate | Set Funding Bank Details
 
 
 
@@ -410,13 +410,13 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## set_notifications_request
+## list_funding_audit_deltas
 
-> set_notifications_request(source_account_id, set_notifications_request)
+> FundingDeltaResponse list_funding_audit_deltas(payor_id, updated_since, opts)
 
-Set notifications
+List Funding changes
 
-Set notifications for a given source account
+Get a paginated response listing funding changes.
 
 ### Example
 
@@ -430,14 +430,19 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::FundingManagerApi.new
-source_account_id = 'source_account_id_example' # String | Source account id
-set_notifications_request = VeloPayments::SetNotificationsRequest.new # SetNotificationsRequest | Body to included minimum balance to set
+payor_id = 'payor_id_example' # String | The Payor ID to find associated funding records
+updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+opts = {
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+}
 
 begin
-  #Set notifications
-  api_instance.set_notifications_request(source_account_id, set_notifications_request)
+  #List Funding changes
+  result = api_instance.list_funding_audit_deltas(payor_id, updated_since, opts)
+  p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling FundingManagerApi->set_notifications_request: #{e}"
+  puts "Exception when calling FundingManagerApi->list_funding_audit_deltas: #{e}"
 end
 ```
 
@@ -446,12 +451,14 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **source_account_id** | [**String**](.md)| Source account id | 
- **set_notifications_request** | [**SetNotificationsRequest**](SetNotificationsRequest.md)| Body to included minimum balance to set | 
+ **payor_id** | [**String**](.md)| The Payor ID to find associated funding records | 
+ **updated_since** | **DateTime**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | 
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+ **page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
 
 ### Return type
 
-nil (empty response body)
+[**FundingDeltaResponse**](FundingDeltaResponse.md)
 
 ### Authorization
 
@@ -459,17 +466,17 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: application/json
-- **Accept**: Not defined
+- **Content-Type**: Not defined
+- **Accept**: application/json
 
 
-## set_payor_funding_bank_details
+## set_notifications_request
 
-> set_payor_funding_bank_details(payor_id, payor_funding_bank_details_update)
+> set_notifications_request(source_account_id, set_notifications_request)
 
-Set Funding Bank Details
+Set notifications
 
-This API allows you to set or update the funding details for the given Payor ID. 
+Set notifications for a given source account
 
 ### Example
 
@@ -483,14 +490,14 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::FundingManagerApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
-payor_funding_bank_details_update = VeloPayments::PayorFundingBankDetailsUpdate.new # PayorFundingBankDetailsUpdate | Update Funding bank details of given Payor Id
+source_account_id = 'source_account_id_example' # String | Source account id
+set_notifications_request = VeloPayments::SetNotificationsRequest.new # SetNotificationsRequest | Body to included minimum balance to set
 
 begin
-  #Set Funding Bank Details
-  api_instance.set_payor_funding_bank_details(payor_id, payor_funding_bank_details_update)
+  #Set notifications
+  api_instance.set_notifications_request(source_account_id, set_notifications_request)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling FundingManagerApi->set_payor_funding_bank_details: #{e}"
+  puts "Exception when calling FundingManagerApi->set_notifications_request: #{e}"
 end
 ```
 
@@ -499,8 +506,8 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
- **payor_funding_bank_details_update** | [**PayorFundingBankDetailsUpdate**](PayorFundingBankDetailsUpdate.md)| Update Funding bank details of given Payor Id | 
+ **source_account_id** | [**String**](.md)| Source account id | 
+ **set_notifications_request** | [**SetNotificationsRequest**](SetNotificationsRequest.md)| Body to included minimum balance to set | 
 
 ### Return type
 

data/docs/GetFundingsResponse.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **page** | [**PagedResponsePage**](PagedResponsePage.md) |  | [optional] 
 **links** | **Array<Object>** |  | [optional] 
-**content** | [**FundingAudit**](FundingAudit.md) |  | [optional] 
+**content** | [**Array<FundingAudit>**](FundingAudit.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/GetFundingsResponseAllOf.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**content** | [**FundingAudit**](FundingAudit.md) |  | [optional] 
+**content** | [**Array<FundingAudit>**](FundingAudit.md) |  | [optional] 
 
 ## Code Sample
 

data/docs/GetPaymentsForPayoutResponseV4.md

@@ -5,8 +5,8 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **summary** | [**GetPaymentsForPayoutResponseV4Summary**](GetPaymentsForPayoutResponseV4Summary.md) |  | [optional] 
-**page** | [**PayeeResponsePage**](PayeeResponsePage.md) |  | [optional] 
-**links** | [**Array<PayeeResponseLinks>**](PayeeResponseLinks.md) |  | [optional] 
+**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV4>**](PaymentResponseV4.md) |  | [optional] 
 
 ## Code Sample

data/docs/GetPaymentsForPayoutResponseV4Summary.md

@@ -8,6 +8,14 @@ Name | Type | Description | Notes
 **submitted_date_time** | **DateTime** | The date/time at which the payout was submitted. | [optional] 
 **instructed_date_time** | **DateTime** | The date/time at which the payout was instructed. | [optional] 
 **payout_memo** | **String** | The memo attached to the payout. | [optional] 
+**payout_type** | [**PayoutTypeV4**](PayoutTypeV4.md) |  | [optional] 
+**quoted_date_time** | **DateTime** | The date/time at which the payout was quoted. | [optional] 
+**submitting** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
+**payout_from** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
+**payout_to** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
+**quoted** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
+**instructed** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
+**withdrawn** | [**PayoutPrincipalV4**](PayoutPrincipalV4.md) |  | [optional] 
 **total_payments** | **Integer** | The count of payments within the payout. | [optional] 
 **confirmed_payments** | **Integer** | The count of payments within the payout which have been confirmed. | [optional] 
 **released_payments** | **Integer** | The count of payments within the payout which have been released. | [optional] 
@@ -23,6 +31,14 @@ instance = VeloPayments::GetPaymentsForPayoutResponseV4Summary.new(payout_status
                                  submitted_date_time: null,
                                  instructed_date_time: null,
                                  payout_memo: null,
+                                 payout_type: null,
+                                 quoted_date_time: null,
+                                 submitting: null,
+                                 payout_from: null,
+                                 payout_to: null,
+                                 quoted: null,
+                                 instructed: null,
+                                 withdrawn: null,
                                  total_payments: null,
                                  confirmed_payments: null,
                                  released_payments: null,

data/docs/GetPayoutsResponseV4.md

@@ -4,9 +4,9 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**summary** | [**PayeeResponseSummary**](PayeeResponseSummary.md) |  | [optional] 
-**page** | [**PayeeResponsePage**](PayeeResponsePage.md) |  | [optional] 
-**links** | [**Array<PayeeResponseLinks>**](PayeeResponseLinks.md) |  | [optional] 
+**summary** | [**PagedPayeeResponseSummary**](PagedPayeeResponseSummary.md) |  | [optional] 
+**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PayoutSummaryAuditV4>**](PayoutSummaryAuditV4.md) |  | [optional] 
 
 ## Code Sample

data/docs/IndividualResponse.md

@@ -0,0 +1,17 @@
+# VeloPayments::IndividualResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::IndividualResponse.new(name: null)
+```
+
+

data/docs/{Individual.md → IndividualV1.md}

@@ -1,19 +1,19 @@
-# VeloPayments::Individual
+# VeloPayments::IndividualV1
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | [**IndividualName**](IndividualName.md) |  | 
-**national_identification** | **String** | If not authorized to view, value will be masked. Example: XXXXX1234 | [optional] 
-**date_of_birth** | **String** | If not authorized to view, value will be masked. Example: - XXXX-XX-XX | 
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+**national_identification** | **String** | If not authorized to view, value will be masked. Example: XXXXX1234 | [optional] [readonly] 
+**date_of_birth** | **String** | If not authorized to view, value will be masked. Example: - XXXX-XX-XX | [readonly] 
 
 ## Code Sample
 
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::Individual.new(name: null,
+instance = VeloPayments::IndividualV1.new(name: null,
                                  national_identification: null,
                                  date_of_birth: null)
 ```

data/docs/{IndividualName.md → IndividualV1Name.md}

@@ -1,4 +1,4 @@
-# VeloPayments::IndividualName
+# VeloPayments::IndividualV1Name
 
 ## Properties
 
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::IndividualName.new(title: null,
+instance = VeloPayments::IndividualV1Name.new(title: null,
                                  first_name: null,
                                  other_names: null,
                                  last_name: null)

data/docs/PagedPayeeInvitationStatusResponse.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**PayeeResponsePage**](PayeeResponsePage.md) |  | [optional] 
-**links** | [**Array<PayeeResponseLinks>**](PayeeResponseLinks.md) |  | [optional] 
+**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PayeeInvitationStatusResponse>**](PayeeInvitationStatusResponse.md) |  | [optional] 
 
 ## Code Sample

data/docs/PagedPayeeResponse.md

@@ -0,0 +1,23 @@
+# VeloPayments::PagedPayeeResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**summary** | [**PagedPayeeResponseSummary**](PagedPayeeResponseSummary.md) |  | [optional] 
+**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
+**content** | [**Array<PayeeResponse>**](PayeeResponse.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PagedPayeeResponse.new(summary: null,
+                                 page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/PagedPayeeResponse2.md

@@ -0,0 +1,23 @@
+# VeloPayments::PagedPayeeResponse2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**summary** | [**PagedPayeeResponse2Summary**](PagedPayeeResponse2Summary.md) |  | [optional] 
+**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
+**content** | [**Array<PayeeResponse2>**](PayeeResponse2.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PagedPayeeResponse2.new(summary: null,
+                                 page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/PagedPayeeResponse2Summary.md

@@ -0,0 +1,25 @@
+# VeloPayments::PagedPayeeResponse2Summary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total_payees_count** | **Integer** |  | [optional] 
+**total_invited_count** | **Integer** |  | [optional] 
+**total_registered_count** | **Integer** |  | [optional] 
+**total_onboarded_count** | **Integer** |  | [optional] 
+**total_watchlist_failed_count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PagedPayeeResponse2Summary.new(total_payees_count: null,
+                                 total_invited_count: null,
+                                 total_registered_count: null,
+                                 total_onboarded_count: null,
+                                 total_watchlist_failed_count: null)
+```
+
+

data/docs/{PayeeResponseLinks.md → PagedPayeeResponseLinks.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayeeResponseLinks
+# VeloPayments::PagedPayeeResponseLinks
 
 ## Properties
 
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayeeResponseLinks.new(rel: null,
+instance = VeloPayments::PagedPayeeResponseLinks.new(rel: null,
                                  href: null)
 ```
 

data/docs/{PayeeResponsePage.md → PagedPayeeResponsePage.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayeeResponsePage
+# VeloPayments::PagedPayeeResponsePage
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayeeResponsePage.new(number_of_elements: null,
+instance = VeloPayments::PagedPayeeResponsePage.new(number_of_elements: null,
                                  total_elements: null,
                                  total_pages: null,
                                  page: null,

data/docs/{PayeeResponseSummary.md → PagedPayeeResponseSummary.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayeeResponseSummary
+# VeloPayments::PagedPayeeResponseSummary
 
 ## Properties
 
@@ -15,7 +15,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayeeResponseSummary.new(total_payees_count: null,
+instance = VeloPayments::PagedPayeeResponseSummary.new(total_payees_count: null,
                                  total_invited_count: null,
                                  total_registered_count: null,
                                  total_onboarded_count: null,

data/docs/Payee.md

@@ -4,23 +4,23 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payee_id** | **String** |  | [optional] 
-**payor_refs** | [**Array<PayorRef>**](PayorRef.md) |  | [optional] 
+**payee_id** | **String** |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRef>**](PayeePayorRef.md) |  | [optional] [readonly] 
 **email** | **String** |  | [optional] 
-**address** | [**Address**](Address.md) |  | [optional] 
+**address** | [**PayeeAddress**](PayeeAddress.md) |  | [optional] 
 **country** | **String** |  | [optional] 
 **display_name** | **String** |  | [optional] 
-**payment_channel** | [**PaymentChannel**](PaymentChannel.md) |  | [optional] 
+**payment_channel** | [**PayeePaymentChannel**](PayeePaymentChannel.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] 
+**accept_terms_and_conditions_timestamp** | **DateTime** | The timestamp when the payee last accepted T&Cs | [optional] [readonly] 
 **cellphone_number** | **String** |  | [optional] 
 **payee_type** | [**PayeeType**](PayeeType.md) |  | [optional] 
-**company** | [**Company**](Company.md) |  | [optional] 
-**individual** | [**Individual**](Individual.md) |  | [optional] 
+**company** | [**CompanyV1**](CompanyV1.md) |  | [optional] 
+**individual** | [**IndividualV1**](IndividualV1.md) |  | [optional] 
 **created** | **DateTime** |  | [optional] 
-**grace_period_end_date** | **Date** |  | [optional] 
-**last_ofac_check_timestamp** | **String** |  | [optional] 
+**grace_period_end_date** | **Date** |  | [optional] [readonly] 
+**last_ofac_check_timestamp** | **String** |  | [optional] [readonly] 
 **marketing_opt_ins** | [**Array<MarketingOptIn>**](MarketingOptIn.md) |  | [optional] 
 **ofac_status** | [**OfacStatus**](OfacStatus.md) |  | [optional] 
 **onboarded_status** | [**OnboardedStatus**](OnboardedStatus.md) |  | [optional]