velopayments 2.11.73

data/docs/FundingRequest2.md

@@ -0,0 +1,17 @@
+# VeloPayments::FundingRequest2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**amount** | **Integer** | Amount to fund, decimal implied | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FundingRequest2.new(amount: null)
+```
+
+

data/docs/FxSummary.md

@@ -0,0 +1,35 @@
+# VeloPayments::FxSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**quote_id** | **String** |  | 
+**creation_date_time** | **DateTime** |  | 
+**rate** | **Float** |  | 
+**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** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::FxSummary.new(quote_id: null,
+                                 creation_date_time: null,
+                                 rate: null,
+                                 inverted_rate: null,
+                                 total_cost: null,
+                                 total_payment_amount: null,
+                                 source_currency: null,
+                                 payment_currency: null,
+                                 status: null,
+                                 funding_status: null)
+```
+
+

data/docs/GetFundingsResponse.md

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

data/docs/GetPaymentsForPayoutResponse.md

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

data/docs/GetPaymentsForPayoutResponseLinks.md

@@ -0,0 +1,19 @@
+# VeloPayments::GetPaymentsForPayoutResponseLinks
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rel** | **String** |  | [optional] 
+**href** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPaymentsForPayoutResponseLinks.new(rel: null,
+                                 href: null)
+```
+
+

data/docs/GetPaymentsForPayoutResponsePage.md

@@ -0,0 +1,25 @@
+# VeloPayments::GetPaymentsForPayoutResponsePage
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**number_of_elements** | **Integer** |  | [optional] 
+**total_elements** | **Integer** |  | [optional] 
+**total_pages** | **Integer** |  | [optional] 
+**page** | **Integer** |  | [optional] 
+**page_size** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPaymentsForPayoutResponsePage.new(number_of_elements: null,
+                                 total_elements: null,
+                                 total_pages: null,
+                                 page: null,
+                                 page_size: null)
+```
+
+

data/docs/GetPaymentsForPayoutResponseSummary.md

@@ -0,0 +1,25 @@
+# VeloPayments::GetPaymentsForPayoutResponseSummary
+
+## 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_ofac_failed_count** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPaymentsForPayoutResponseSummary.new(total_payees_count: null,
+                                 total_invited_count: null,
+                                 total_registered_count: null,
+                                 total_onboarded_count: null,
+                                 total_ofac_failed_count: null)
+```
+
+

data/docs/GetPayoutApi.md

@@ -0,0 +1,61 @@
+# VeloPayments::GetPayoutApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**v3_payouts_payout_id_get**](GetPayoutApi.md#v3_payouts_payout_id_get) | **GET** /v3/payouts/{payoutId} | Get Payout Summary
+
+
+
+## v3_payouts_payout_id_get
+
+> PayoutSummaryResponse v3_payouts_payout_id_get(payout_id)
+
+Get Payout Summary
+
+Get payout summary - returns the current state of the payout.
+
+### 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::GetPayoutApi.new
+payout_id = 'payout_id_example' # String | Id of the payout
+
+begin
+  #Get Payout Summary
+  result = api_instance.v3_payouts_payout_id_get(payout_id)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling GetPayoutApi->v3_payouts_payout_id_get: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| Id of the payout | 
+
+### Return type
+
+[**PayoutSummaryResponse**](PayoutSummaryResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/GetPayoutStatistics.md

@@ -0,0 +1,19 @@
+# VeloPayments::GetPayoutStatistics
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**this_month_payouts_count** | **Integer** |  | 
+**this_month_failed_payments_count** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::GetPayoutStatistics.new(this_month_payouts_count: null,
+                                 this_month_failed_payments_count: null)
+```
+
+

data/docs/GetPayoutsResponse.md

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

data/docs/Individual.md

@@ -0,0 +1,21 @@
+# VeloPayments::Individual
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**IndividualName**](IndividualName.md) |  | 
+**national_identification** | [**OneOfstringstring**](OneOfstringstring.md) |  | [optional] 
+**date_of_birth** | [**OneOfdatestring**](OneOfdatestring.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Individual.new(name: null,
+                                 national_identification: null,
+                                 date_of_birth: null)
+```
+
+

data/docs/IndividualName.md

@@ -0,0 +1,23 @@
+# VeloPayments::IndividualName
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**title** | **String** |  | [optional] 
+**first_name** | **String** |  | 
+**other_names** | **String** |  | [optional] 
+**last_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::IndividualName.new(title: null,
+                                 first_name: null,
+                                 other_names: null,
+                                 last_name: null)
+```
+
+

data/docs/InstructPayoutApi.md

@@ -0,0 +1,60 @@
+# VeloPayments::InstructPayoutApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**v3_payouts_payout_id_post**](InstructPayoutApi.md#v3_payouts_payout_id_post) | **POST** /v3/payouts/{payoutId} | Instruct Payout
+
+
+
+## v3_payouts_payout_id_post
+
+> v3_payouts_payout_id_post(payout_id)
+
+Instruct Payout
+
+Instruct a payout to be made for the specified payoutId.
+
+### 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::InstructPayoutApi.new
+payout_id = 'payout_id_example' # String | Id of the payout
+
+begin
+  #Instruct Payout
+  api_instance.v3_payouts_payout_id_post(payout_id)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling InstructPayoutApi->v3_payouts_payout_id_post: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| Id of the payout | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/InvitationStatusResponse.md

@@ -0,0 +1,17 @@
+# VeloPayments::InvitationStatusResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_invitation_statuses** | [**Array<PayeeInvitationStatus>**](PayeeInvitationStatus.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InvitationStatusResponse.new(payee_invitation_statuses: null)
+```
+
+

data/docs/InvitePayeeRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::InvitePayeeRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::InvitePayeeRequest.new(payor_id: null)
+```
+
+

data/docs/Language.md

@@ -0,0 +1,16 @@
+# VeloPayments::Language
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Language.new()
+```
+
+