velopayments 2.14.90.pre.1 → 2.17.8.beta1

data/docs/CreateIndividual.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**name** | [**IndividualName**](IndividualName.md) |  | 
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
 **national_identification** | **String** |  | [optional] 
 **date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | 
 

data/docs/CreateIndividual2.md

@@ -0,0 +1,21 @@
+# VeloPayments::CreateIndividual2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**IndividualV1Name**](IndividualV1Name.md) |  | 
+**national_identification** | **String** |  | [optional] 
+**date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreateIndividual2.new(name: null,
+                                 national_identification: null,
+                                 date_of_birth: null)
+```
+
+

data/docs/CreatePayee.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payee_id** | **String** |  | [optional] 
-**payor_refs** | [**Array<PayorRef>**](PayorRef.md) |  | [optional] 
+**payee_id** | **String** |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) |  | [optional] [readonly] 
 **email** | **String** |  | 
 **remote_id** | **String** |  | 
 **type** | [**PayeeType**](PayeeType.md) |  | 
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **payment_channel** | [**CreatePaymentChannel**](CreatePaymentChannel.md) |  | [optional] 
 **challenge** | [**Challenge**](Challenge.md) |  | [optional] 
 **language** | [**Language**](Language.md) |  | [optional] 
-**company** | [**Company**](Company.md) |  | [optional] 
+**company** | [**CompanyV1**](CompanyV1.md) |  | [optional] 
 **individual** | [**CreateIndividual**](CreateIndividual.md) |  | [optional] 
 
 ## Code Sample

data/docs/CreatePayee2.md

@@ -0,0 +1,37 @@
+# VeloPayments::CreatePayee2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | [optional] [readonly] 
+**payor_refs** | [**Array<PayeePayorRef2>**](PayeePayorRef2.md) |  | [optional] [readonly] 
+**email** | **String** |  | 
+**remote_id** | **String** |  | 
+**type** | [**PayeeType**](PayeeType.md) |  | 
+**address** | [**CreatePayeeAddress2**](CreatePayeeAddress2.md) |  | 
+**payment_channel** | [**CreatePaymentChannel2**](CreatePaymentChannel2.md) |  | [optional] 
+**challenge** | [**Challenge**](Challenge.md) |  | [optional] 
+**language** | [**Language**](Language.md) |  | [optional] 
+**company** | [**CompanyV1**](CompanyV1.md) |  | [optional] 
+**individual** | [**CreateIndividual2**](CreateIndividual2.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayee2.new(payee_id: null,
+                                 payor_refs: null,
+                                 email: null,
+                                 remote_id: null,
+                                 type: null,
+                                 address: null,
+                                 payment_channel: null,
+                                 challenge: null,
+                                 language: null,
+                                 company: null,
+                                 individual: null)
+```
+
+

data/docs/CreatePayeeAddress.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **city** | **String** |  | 
 **county_or_province** | **String** |  | [optional] 
 **zip_or_postcode** | **String** |  | [optional] 
-**country** | **String** |  | 
+**country** | **String** | Ideally a 2 letter ISO 3166-1 country code.  But a limited set of additional values will be corrected.  See Java Locale.getISOCountries() and Locale.getDisplayCountry() | 
 
 ## Code Sample
 

data/docs/CreatePayeeAddress2.md

@@ -0,0 +1,31 @@
+# VeloPayments::CreatePayeeAddress2
+
+## 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** | 2 letter ISO 3166-1 country code | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayeeAddress2.new(line1: 500 Duval St,
+                                 line2: null,
+                                 line3: null,
+                                 line4: null,
+                                 city: Key West,
+                                 county_or_province: FL,
+                                 zip_or_postcode: 33945,
+                                 country: US)
+```
+
+

data/docs/CreatePayeesCSVRequest.md

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
 **address_city** | **String** |  | 
 **address_county_or_province** | **String** |  | [optional] 
 **address_zip_or_postcode** | **String** |  | 
-**address_country** | **String** |  | 
+**address_country** | **String** | Ideally a 2 letter ISO 3166-1 country code.  But a limited set of additional values will be corrected.  See Java Locale.getISOCountries() and Locale.getDisplayCountry() | 
 **individual_national_identification** | **String** |  | [optional] 
 **individual_date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | [optional] 
 **individual_title** | **String** |  | [optional] 

data/docs/CreatePayeesCSVRequest2.md

@@ -0,0 +1,73 @@
+# VeloPayments::CreatePayeesCSVRequest2
+
+## 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** | Must be a 2 character country code - per ISO 3166-1 | 
+**individual_national_identification** | **String** |  | [optional] 
+**individual_date_of_birth** | **Date** | Must not be date in future. Example - 1970-05-20 | [optional] 
+**individual_title** | **String** |  | [optional] 
+**individual_first_name** | **String** |  | [optional] 
+**individual_other_names** | **String** |  | [optional] 
+**individual_last_name** | **String** |  | [optional] 
+**company_name** | **String** |  | [optional] 
+**company_ein** | **String** | Company Tax Id (EIN) must be 9 numeric characters. Must match the regular expression ```[\\d]{9}```. | [optional] 
+**company_operating_name** | **String** |  | [optional] 
+**payment_channel_account_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**payment_channel_routing_number** | **String** | Either routing number and account number or only iban must be set | [optional] 
+**payment_channel_account_name** | **String** |  | [optional] 
+**payment_channel_iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional] 
+**payment_channel_country_code** | **String** | Must be a 2 character country code - per ISO 3166-1 | [optional] 
+**payment_channel_currency** | **String** |  | [optional] 
+**challenge_description** | **String** |  | [optional] 
+**challenge_value** | **String** |  | [optional] 
+**payee_language** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::CreatePayeesCSVRequest2.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_national_identification: null,
+                                 individual_date_of_birth: null,
+                                 individual_title: null,
+                                 individual_first_name: null,
+                                 individual_other_names: null,
+                                 individual_last_name: null,
+                                 company_name: null,
+                                 company_ein: null,
+                                 company_operating_name: null,
+                                 payment_channel_account_number: null,
+                                 payment_channel_routing_number: null,
+                                 payment_channel_account_name: null,
+                                 payment_channel_iban: null,
+                                 payment_channel_country_code: null,
+                                 payment_channel_currency: null,
+                                 challenge_description: null,
+                                 challenge_value: null,
+                                 payee_language: null)
+```
+
+

data/docs/CreatePayeesCSVResponse2.md

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

data/docs/CreatePayeesRequest2.md

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

data/docs/CreatePaymentChannel2.md

@@ -0,0 +1,29 @@
+# VeloPayments::CreatePaymentChannel2
+
+## 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::CreatePaymentChannel2.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

@@ -4,8 +4,10 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payor_id** | **String** |  | 
-**payout_memo** | **String** |  | [optional] 
+**payor_id** | **String** | Deprecated in v2.16. Any value supplied here will be ignored. | [optional] 
+**payout_from_payor_id** | **String** | The id of the payor whose source account(s) will be debited. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted. | [optional] 
+**payout_to_payor_id** | **String** | The id of the payor whose payees will be paid. payoutFromPayorId and payoutToPayorId must be both supplied or both omitted. | [optional] 
+**payout_memo** | **String** | Text applied to all payment memos unless specified explicitly on a payment. This should be the reference field on the statement seen by the payee (but not via ACH) | [optional] 
 **payments** | [**Array<PaymentInstruction>**](PaymentInstruction.md) |  | 
 
 ## Code Sample
@@ -14,6 +16,8 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::CreatePayoutRequest.new(payor_id: null,
+                                 payout_from_payor_id: null,
+                                 payout_to_payor_id: null,
                                  payout_memo: A memo,
                                  payments: null)
 ```

data/docs/Error.md

@@ -0,0 +1,23 @@
+# VeloPayments::Error
+
+## 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** | **String** | the location type in the request that was the cause of the error  | [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::Error.new(error_message: smsNumber must be in the E.164 format e.g. +15551231234,
+                                 location: smsNumber,
+                                 location_type: requestBody,
+                                 reason_code: validationError)
+```
+
+

data/docs/ErrorResponse.md

@@ -0,0 +1,19 @@
+# VeloPayments::ErrorResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**errors** | [**Array<Error>**](Error.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::ErrorResponse.new(errors: null,
+                                 correlation_id: ee53e01d-c078-43fd-abd4-47e92f4a06cf)
+```
+
+

data/docs/FundingAudit.md

@@ -12,6 +12,7 @@ Name | Type | Description | Notes
 **funding_account_name** | **String** |  | [optional] 
 **funding_type** | **String** |  | [optional] 
 **events** | [**Array<FundingEvent>**](FundingEvent.md) |  | [optional] 
+**topup_type** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -25,7 +26,8 @@ instance = VeloPayments::FundingAudit.new(amount: null,
                                  source_account_name: null,
                                  funding_account_name: null,
                                  funding_type: null,
-                                 events: null)
+                                 events: null,
+                                 topup_type: null)
 ```
 
 

data/docs/FundingDelta.md

@@ -0,0 +1,23 @@
+# VeloPayments::FundingDelta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** |  | 
+**funding_id** | **String** |  | [readonly] 
+**amount** | **Integer** | Amount to fund in minor units | [optional] 
+**currency** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingDelta.new(status: ALLOCATED,
+                                 funding_id: null,
+                                 amount: 100000,
+                                 currency: USD)
+```
+
+

data/docs/FundingDeltaResponse.md

@@ -0,0 +1,21 @@
+# VeloPayments::FundingDeltaResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**PayeeDeltaResponsePage**](PayeeDeltaResponsePage.md) |  | [optional] 
+**links** | [**Array<FundingDeltaResponseLinks>**](FundingDeltaResponseLinks.md) |  | [optional] 
+**content** | [**Array<FundingDelta>**](FundingDelta.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingDeltaResponse.new(page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/FundingDeltaResponseLinks.md

@@ -0,0 +1,19 @@
+# VeloPayments::FundingDeltaResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingDeltaResponseLinks.new(rel: first,
+                                 href: http://api.sandbox.velopayments.com/v1/deltas/fundings?payorId=0a818933-087d-47f2-ad83-2f986ed087eb&updatedSince=2019-01-20T09:00:00+00:00&page=1&pageSize=1000)
+```
+
+