velopayments 2.11.73

data/docs/PayoutStatus.md

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

data/docs/PayoutSummaryAudit.md

@@ -0,0 +1,39 @@
+# VeloPayments::PayoutSummaryAudit
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_id** | **String** |  | 
+**payor_id** | **String** |  | [optional] 
+**status** | [**PayoutStatus**](PayoutStatus.md) |  | 
+**date_time** | **DateTime** |  | [optional] 
+**submitted_date_time** | **String** |  | 
+**instructed_date_time** | **String** |  | [optional] 
+**total_payments** | **Integer** |  | [optional] 
+**total_incomplete_payments** | **Integer** |  | [optional] 
+**total_failed_payments** | **Integer** |  | [optional] 
+**source_account_summary** | [**Array<SourceAccountSummary>**](SourceAccountSummary.md) |  | [optional] 
+**fx_summaries** | [**Array<FxSummary>**](FxSummary.md) |  | [optional] 
+**payout_memo** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutSummaryAudit.new(payout_id: null,
+                                 payor_id: null,
+                                 status: null,
+                                 date_time: null,
+                                 submitted_date_time: null,
+                                 instructed_date_time: null,
+                                 total_payments: null,
+                                 total_incomplete_payments: null,
+                                 total_failed_payments: null,
+                                 source_account_summary: null,
+                                 fx_summaries: null,
+                                 payout_memo: null)
+```
+
+

data/docs/PayoutSummaryResponse.md

@@ -0,0 +1,31 @@
+# VeloPayments::PayoutSummaryResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_id** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**payments_submitted** | **Integer** |  | [optional] 
+**payments_accepted** | **Integer** |  | [optional] 
+**payments_rejected** | **Integer** |  | [optional] 
+**fx_summaries** | [**Array<QuoteFxSummary>**](QuoteFxSummary.md) |  | 
+**accounts** | [**Array<SourceAccount>**](SourceAccount.md) |  | 
+**rejected_payments** | [**Array<RejectedPayment>**](RejectedPayment.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutSummaryResponse.new(payout_id: null,
+                                 status: null,
+                                 payments_submitted: null,
+                                 payments_accepted: null,
+                                 payments_rejected: null,
+                                 fx_summaries: null,
+                                 accounts: null,
+                                 rejected_payments: null)
+```
+
+

data/docs/QueryBatchResponse.md

@@ -0,0 +1,23 @@
+# VeloPayments::QueryBatchResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**status** | **String** | Batch Status | [optional] 
+**failure_count** | **Integer** |  | [optional] 
+**pending_count** | **Integer** |  | [optional] 
+**failures** | [**Array<FailedSubmission>**](FailedSubmission.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::QueryBatchResponse.new(status: null,
+                                 failure_count: null,
+                                 pending_count: null,
+                                 failures: null)
+```
+
+

data/docs/QuoteFxSummary.md

@@ -0,0 +1,37 @@
+# VeloPayments::QuoteFxSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**rate** | **Object** |  | 
+**inverted_rate** | **Object** |  | [optional] 
+**creation_time** | **DateTime** |  | 
+**expiry_time** | **DateTime** |  | [optional] 
+**quote_id** | **String** |  | 
+**total_source_amount** | **Integer** |  | 
+**total_payment_amount** | **Integer** |  | 
+**source_currency** | **String** |  | 
+**payment_currency** | **String** |  | 
+**funding_status** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::QuoteFxSummary.new(rate: null,
+                                 inverted_rate: null,
+                                 creation_time: null,
+                                 expiry_time: null,
+                                 quote_id: null,
+                                 total_source_amount: null,
+                                 total_payment_amount: null,
+                                 source_currency: null,
+                                 payment_currency: null,
+                                 funding_status: null,
+                                 status: null)
+```
+
+

data/docs/QuotePayoutApi.md

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

data/docs/QuoteResponse.md

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

data/docs/RejectedPayment.md

@@ -0,0 +1,31 @@
+# VeloPayments::RejectedPayment
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote_id** | **String** |  | 
+**currency_type** | **String** |  | 
+**amount** | **Integer** |  | 
+**source_account_name** | **String** |  | 
+**payor_payment_id** | **String** |  | 
+**reason** | **String** |  | 
+**line_number** | **Integer** |  | [optional] 
+**message** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::RejectedPayment.new(remote_id: null,
+                                 currency_type: null,
+                                 amount: null,
+                                 source_account_name: null,
+                                 payor_payment_id: null,
+                                 reason: null,
+                                 line_number: null,
+                                 message: null)
+```
+
+

data/docs/Social.md

@@ -0,0 +1,21 @@
+# VeloPayments::Social
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**twitter_id** | **String** |  | [optional] 
+**facebook_id** | **String** |  | [optional] 
+**linked_in_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Social.new(twitter_id: null,
+                                 facebook_id: null,
+                                 linked_in_id: null)
+```
+
+

data/docs/SourceAccount.md

@@ -0,0 +1,23 @@
+# VeloPayments::SourceAccount
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_account_name** | **String** |  | 
+**source_account_id** | **String** |  | 
+**currency** | **String** |  | 
+**total_payout_cost** | **Integer** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SourceAccount.new(source_account_name: null,
+                                 source_account_id: null,
+                                 currency: null,
+                                 total_payout_cost: null)
+```
+
+

data/docs/SourceAccountResponse.md

@@ -0,0 +1,39 @@
+# VeloPayments::SourceAccountResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Source Account Id | [optional] 
+**balance** | **Object** | Decimal implied | [optional] 
+**currency** | **String** |  | [optional] 
+**funding_ref** | **String** |  | [optional] 
+**physical_account_name** | **String** |  | [optional] 
+**rails_id** | **String** |  | [optional] 
+**payor_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**pooled** | **Boolean** |  | [optional] 
+**balance_visible** | **Boolean** |  | [optional] 
+**customer_id** | **String** |  | [optional] 
+**physical_account_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SourceAccountResponse.new(id: null,
+                                 balance: null,
+                                 currency: null,
+                                 funding_ref: null,
+                                 physical_account_name: null,
+                                 rails_id: null,
+                                 payor_id: null,
+                                 name: null,
+                                 pooled: null,
+                                 balance_visible: null,
+                                 customer_id: null,
+                                 physical_account_id: null)
+```
+
+

data/docs/SourceAccountSummary.md

@@ -0,0 +1,21 @@
+# VeloPayments::SourceAccountSummary
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**source_account_id** | **String** |  | 
+**total_cost** | **Object** |  | 
+**currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SourceAccountSummary.new(source_account_id: null,
+                                 total_cost: null,
+                                 currency: null)
+```
+
+

data/docs/SubmitPayoutApi.md

@@ -0,0 +1,60 @@
+# VeloPayments::SubmitPayoutApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**submit_payout**](SubmitPayoutApi.md#submit_payout) | **POST** /v3/payouts | Submit Payout
+
+
+
+## submit_payout
+
+> submit_payout(create_payout_request)
+
+Submit Payout
+
+Create a new payout and return a location header with a link to get the payout. Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously, the results of which can be obtained by issuing a HTTP GET to the URL returned in the location header. **NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.  with no decimal places. 
+
+### 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::SubmitPayoutApi.new
+create_payout_request = VeloPayments::CreatePayoutRequest.new # CreatePayoutRequest | Post ammount to transfer via ACH using stored funding account details.
+
+begin
+  #Submit Payout
+  api_instance.submit_payout(create_payout_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling SubmitPayoutApi->submit_payout: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payout_request** | [**CreatePayoutRequest**](CreatePayoutRequest.md)| Post ammount to transfer via ACH using stored funding account details. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: Not defined
+

data/docs/SupportedCountriesResponse.md

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