velopayments 2.18.113 → 2.23.78.beta1

data/docs/{DefaultApi.md → FundingManagerPrivateApi.md}

@@ -1,16 +1,16 @@
-# VeloPayments::DefaultApi
+# VeloPayments::FundingManagerPrivateApi
 
 All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**create_funding_account**](DefaultApi.md#create_funding_account) | **POST** /v1/fundingAccounts | Create Funding Account
+[**create_funding_account_v2**](FundingManagerPrivateApi.md#create_funding_account_v2) | **POST** /v2/fundingAccounts | Create Funding Account
 
 
 
-## create_funding_account
+## create_funding_account_v2
 
-> create_funding_account(opts)
+> create_funding_account_v2(opts)
 
 Create Funding Account
 
@@ -27,16 +27,16 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::DefaultApi.new
+api_instance = VeloPayments::FundingManagerPrivateApi.new
 opts = {
-  create_funding_account_request: VeloPayments::CreateFundingAccountRequest.new # CreateFundingAccountRequest | 
+  create_funding_account_request_v2: {"type":"FBO","name":"My FBO Account","payorId":"ee53e01d-c078-43fd-abd4-47e92f4a06cf","accountName":"My Account Name","accountNumber":1231231234556,"routingNumber":123456789} # CreateFundingAccountRequestV2 | 
 }
 
 begin
   #Create Funding Account
-  api_instance.create_funding_account(opts)
+  api_instance.create_funding_account_v2(opts)
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling DefaultApi->create_funding_account: #{e}"
+  puts "Exception when calling FundingManagerPrivateApi->create_funding_account_v2: #{e}"
 end
 ```
 
@@ -45,7 +45,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **create_funding_account_request** | [**CreateFundingAccountRequest**](CreateFundingAccountRequest.md)|  | [optional] 
+ **create_funding_account_request_v2** | [**CreateFundingAccountRequestV2**](CreateFundingAccountRequestV2.md)|  | [optional] 
 
 ### Return type
 

data/docs/FundingPayorStatusAuditResponse.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **funding_id** | **String** |  | [optional] 
 **amount** | **Integer** |  | [optional] 
-**currency** | [**CurrencyType**](CurrencyType.md) |  | [optional] 
+**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. | [optional] 
 **status** | **String** |  | [optional] 
 
 ## Code Sample
@@ -16,7 +16,7 @@ require 'VeloPayments'
 
 instance = VeloPayments::FundingPayorStatusAuditResponse.new(funding_id: null,
                                  amount: null,
-                                 currency: null,
+                                 currency: USD,
                                  status: null)
 ```
 

data/docs/FundingRequestV3.md

@@ -0,0 +1,19 @@
+# VeloPayments::FundingRequestV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**funding_account_id** | **String** | The funding account id | 
+**amount** | **Integer** | Amount to fund in minor units | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingRequestV3.new(funding_account_id: null,
+                                 amount: null)
+```
+
+

data/docs/FxSummaryV3.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **quote_id** | **String** |  | 
-**creation_date_time** | **DateTime** |  | 
+**creation_date_time** | **Time** |  | 
 **rate** | **Float** |  | 
 **inverted_rate** | **Float** |  | 
 **total_cost** | **Integer** |  | 

data/docs/FxSummaryV4.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **quote_id** | **String** |  | 
-**creation_date_time** | **DateTime** |  | 
+**creation_date_time** | **Time** |  | 
 **rate** | **Float** |  | 
 **inverted_rate** | **Float** |  | 
 **total_cost** | **Integer** |  | 

data/docs/GetFundingsResponse.md

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

data/docs/GetFundingsResponseLinks.md

@@ -0,0 +1,19 @@
+# VeloPayments::GetFundingsResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetFundingsResponseLinks.new(rel: first,
+                                 href: https://api.sandbox.velopayments.com/v1/paymentaudit/fundings?payorId=2a5d8af2-a1ed-4d7f-b9a7-ebe4b333be5a&page=1&pageSize=10)
+```
+
+

data/docs/GetPayeeListResponse.md

@@ -0,0 +1,49 @@
+# VeloPayments::GetPayeeListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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] 
+**watchlist_status_updated_timestamp** | **String** |  | [optional] [readonly] 
+**watchlist_override_comment** | **String** |  | [optional] 
+**language** | [**Language2**](Language2.md) |  | [optional] 
+**created** | **Time** |  | [optional] 
+**country** | **String** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**payee_type** | [**PayeeType**](PayeeType.md) |  | [optional] 
+**disabled** | **Boolean** |  | [optional] 
+**disabled_comment** | **String** |  | [optional] 
+**disabled_updated_timestamp** | **Time** |  | [optional] 
+**individual** | [**GetPayeeListResponseIndividual**](GetPayeeListResponseIndividual.md) |  | [optional] 
+**company** | [**GetPayeeListResponseCompany**](GetPayeeListResponseCompany.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPayeeListResponse.new(payee_id: 2aa5d7e0-2ecb-403f-8494-1865ed0454e9,
+                                 payor_refs: null,
+                                 email: bob@example.com,
+                                 onboarded_status: null,
+                                 watchlist_status: null,
+                                 watchlist_status_updated_timestamp: 2019-01-20T09:00:00+00:00,
+                                 watchlist_override_comment: Example reason for the watchlist status being overridden,
+                                 language: null,
+                                 created: 2019-01-20T09:00Z,
+                                 country: US,
+                                 display_name: ABC,
+                                 payee_type: null,
+                                 disabled: null,
+                                 disabled_comment: reason for disabled,
+                                 disabled_updated_timestamp: 2019-01-20T09:00Z,
+                                 individual: null,
+                                 company: null)
+```
+
+

data/docs/GetPayeeListResponseCompany.md

@@ -0,0 +1,19 @@
+# VeloPayments::GetPayeeListResponseCompany
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** |  | [optional] 
+**operating_name** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPayeeListResponseCompany.new(name: ABC Group Plc,
+                                 operating_name: ABC Co)
+```
+
+

data/docs/GetPayeeListResponseIndividual.md

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

data/docs/GetPaymentsForPayoutResponseV3Summary.md

@@ -5,9 +5,9 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payout_status** | **String** | The current status of the payout. | [optional] 
-**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] 
-**withdrawn_date_time** | **DateTime** | The date/time at which the payout was withdrawn. | [optional] 
+**submitted_date_time** | **Time** | The date/time at which the payout was submitted. | [optional] 
+**instructed_date_time** | **Time** | The date/time at which the payout was instructed. | [optional] 
+**withdrawn_date_time** | **Time** | The date/time at which the payout was withdrawn. | [optional] 
 **payout_memo** | **String** | The memo attached to the payout. | [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] 

data/docs/GetPaymentsForPayoutResponseV4.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **summary** | [**GetPaymentsForPayoutResponseV4Summary**](GetPaymentsForPayoutResponseV4Summary.md) |  | [optional] 
-**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) |  | [optional] 
 **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PaymentResponseV4>**](PaymentResponseV4.md) |  | [optional] 
 

data/docs/GetPaymentsForPayoutResponseV4Summary.md

@@ -5,16 +5,17 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payout_status** | **String** | The current status of the payout. | [optional] 
-**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] 
-**withdrawn_date_time** | **DateTime** |  | [optional] 
-**quoted_date_time** | **DateTime** | The date/time at which the payout was quoted. | [optional] 
+**submitted_date_time** | **Time** | The date/time at which the payout was submitted. | [optional] 
+**instructed_date_time** | **Time** | The date/time at which the payout was instructed. | [optional] 
+**withdrawn_date_time** | **Time** |  | [optional] 
+**quoted_date_time** | **Time** | The date/time at which the payout was quoted. | [optional] 
 **payout_memo** | **String** | The memo attached to the payout. | [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] 
 **incomplete_payments** | **Integer** | The count of payments within the payout which are incomplete. | [optional] 
 **returned_payments** | **Integer** | The count of payments within the payout which have been returned. | [optional] 
+**withdrawn_payments** | **Integer** | The count of payments within the payout which have been withdrawn. | [optional] 
 **payout_type** | [**PayoutTypeV4**](PayoutTypeV4.md) |  | [optional] 
 **submitting** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 **payout_from** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
@@ -39,6 +40,7 @@ instance = VeloPayments::GetPaymentsForPayoutResponseV4Summary.new(payout_status
                                  released_payments: null,
                                  incomplete_payments: null,
                                  returned_payments: null,
+                                 withdrawn_payments: null,
                                  payout_type: null,
                                  submitting: null,
                                  payout_from: null,

data/docs/GetPayoutsResponseV4.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**page** | [**PagedPayeeResponsePage**](PagedPayeeResponsePage.md) |  | [optional] 
+**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) |  | [optional] 
 **links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
 **content** | [**Array<PayoutSummaryAuditV4>**](PayoutSummaryAuditV4.md) |  | [optional] 
 

data/docs/Individual.md

@@ -0,0 +1,21 @@
+# VeloPayments::Individual
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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,
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
+```
+
+

data/docs/Individual2.md

@@ -0,0 +1,21 @@
+# VeloPayments::Individual2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**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::Individual2.new(name: null,
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
+```
+
+

data/docs/IndividualV1.md

@@ -14,8 +14,8 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::IndividualV1.new(name: null,
-                                 national_identification: null,
-                                 date_of_birth: null)
+                                 national_identification: AB123456C,
+                                 date_of_birth: 1985-01-01)
 ```
 
 

data/docs/IndividualV1Name.md

@@ -14,10 +14,10 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::IndividualV1Name.new(title: null,
-                                 first_name: null,
-                                 other_names: null,
-                                 last_name: null)
+instance = VeloPayments::IndividualV1Name.new(title: Mr,
+                                 first_name: Bob,
+                                 other_names: A,
+                                 last_name: Smith)
 ```
 
 

data/docs/InlineResponse400.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse400
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse400Errors>**](InlineResponse400Errors.md) | one or more errors | [optional] 
+**correlation_id** | **String** | a unique identifier to track a request or related sequence of requests | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse400.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse400Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse400Errors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | verbose message indicating the nature of the error Will be localised  | [optional] 
+**location** | **String** | the property or object that caused the error | [optional] 
+**location_type** | [**LocationType**](LocationType.md) |  | [optional] 
+**reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse400Errors.new(error_message: smsNumber must be in the E.164 format e.g. +15551231234,
+                                 location: smsNumber,
+                                 location_type: null,
+                                 reason_code: validationError)
+```
+
+

data/docs/InlineResponse401.md

@@ -0,0 +1,19 @@
+# VeloPayments::InlineResponse401
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<InlineResponse401Errors>**](InlineResponse401Errors.md) | one or more errors | [optional] 
+**correlation_id** | **String** | a unique identifier to track a request or related sequence of requests | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse401.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/InlineResponse401Errors.md

@@ -0,0 +1,23 @@
+# VeloPayments::InlineResponse401Errors
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error_message** | **String** | verbose message indicating the nature of the error Will be localised  | [optional] 
+**location** | **String** | the property or object that caused the error | [optional] 
+**location_type** | [**LocationType**](LocationType.md) |  | [optional] 
+**reason_code** | **String** | a camel-cased string that can be used by clients to localise client error messages | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InlineResponse401Errors.new(error_message: Authentication is required and has not been provided or access has expired,
+                                 location: accessToken,
+                                 location_type: null,
+                                 reason_code: tokenExpired)
+```
+
+