velopayments 2.11.73 → 2.14.90.pre.1

data/docs/PayoutHistoryApi.md

@@ -5,13 +5,14 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**get_payments_for_payout**](PayoutHistoryApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
+[**get_payments_for_payout_v4**](PayoutHistoryApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
 [**get_payout_stats**](PayoutHistoryApi.md#get_payout_stats) | **GET** /v1/paymentaudit/payoutStatistics | Get Payout Statistics
 
 
 
 ## get_payments_for_payout
 
-> GetPaymentsForPayoutResponse get_payments_for_payout(payout_id, opts)
+> GetPaymentsForPayoutResponseV3 get_payments_for_payout(payout_id, opts)
 
 Get Payments for Payout
 
@@ -75,7 +76,85 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**GetPaymentsForPayoutResponse**](GetPaymentsForPayoutResponse.md)
+[**GetPaymentsForPayoutResponseV3**](GetPaymentsForPayoutResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payments_for_payout_v4
+
+> GetPaymentsForPayoutResponseV4 get_payments_for_payout_v4(payout_id, opts)
+
+Get Payments for Payout
+
+Get List of payments for Payout, allowing for RETURNED status 
+
+### 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::PayoutHistoryApi.new
+payout_id = 'payout_id_example' # String | The id (UUID) of the payout.
+opts = {
+  remote_id: 'remote_id_example', # String | The remote id of the payees.
+  status: 'status_example', # String | Payment Status
+  source_amount_from: 56, # Integer | The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom
+  source_amount_to: 56, # Integer | The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo
+  payment_amount_from: 56, # Integer | The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom
+  payment_amount_to: 56, # Integer | The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo
+  submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
+  submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
+  sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status 
+  sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. 
+}
+
+begin
+  #Get Payments for Payout
+  result = api_instance.get_payments_for_payout_v4(payout_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutHistoryApi->get_payments_for_payout_v4: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| The id (UUID) of the payout. | 
+ **remote_id** | **String**| The remote id of the payees. | [optional] 
+ **status** | **String**| Payment Status | [optional] 
+ **source_amount_from** | **Integer**| The source amount from range filter. Filters for sourceAmount >= sourceAmountFrom | [optional] 
+ **source_amount_to** | **Integer**| The source amount to range filter. Filters for sourceAmount ⇐ sourceAmountTo | [optional] 
+ **payment_amount_from** | **Integer**| The payment amount from range filter. Filters for paymentAmount >= paymentAmountFrom | [optional] 
+ **payment_amount_to** | **Integer**| The payment amount to range filter. Filters for paymentAmount ⇐ paymentAmountTo | [optional] 
+ **submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional] 
+ **submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional] 
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+ **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
+ **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by remoteId The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime and status  | [optional] 
+ **sensitive** | **Boolean**| Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.  | [optional] 
+
+### Return type
+
+[**GetPaymentsForPayoutResponseV4**](GetPaymentsForPayoutResponseV4.md)
 
 ### Authorization
 

data/docs/{PayoutStatus.md → PayoutStatusV3.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayoutStatus
+# VeloPayments::PayoutStatusV3
 
 ## Properties
 
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayoutStatus.new()
+instance = VeloPayments::PayoutStatusV3.new()
 ```
 
 

data/docs/PayoutStatusV4.md

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

data/docs/PayoutSummaryAuditV3.md

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

data/docs/{PayoutSummaryAudit.md → PayoutSummaryAuditV4.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PayoutSummaryAudit
+# VeloPayments::PayoutSummaryAuditV4
 
 ## Properties
 
@@ -6,15 +6,16 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payout_id** | **String** |  | 
 **payor_id** | **String** |  | [optional] 
-**status** | [**PayoutStatus**](PayoutStatus.md) |  | 
+**status** | [**PayoutStatusV4**](PayoutStatusV4.md) |  | 
 **date_time** | **DateTime** |  | [optional] 
 **submitted_date_time** | **String** |  | 
 **instructed_date_time** | **String** |  | [optional] 
+**withdrawn_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] 
+**total_returned_payments** | **Integer** |  | [optional] 
+**source_account_summary** | [**Array<SourceAccountSummaryV4>**](SourceAccountSummaryV4.md) |  | [optional] 
+**fx_summaries** | [**Array<FxSummaryV4>**](FxSummaryV4.md) |  | [optional] 
 **payout_memo** | **String** |  | [optional] 
 
 ## Code Sample
@@ -22,15 +23,16 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PayoutSummaryAudit.new(payout_id: null,
+instance = VeloPayments::PayoutSummaryAuditV4.new(payout_id: null,
                                  payor_id: null,
                                  status: null,
                                  date_time: null,
                                  submitted_date_time: null,
                                  instructed_date_time: null,
+                                 withdrawn_date_time: null,
                                  total_payments: null,
                                  total_incomplete_payments: null,
-                                 total_failed_payments: null,
+                                 total_returned_payments: null,
                                  source_account_summary: null,
                                  fx_summaries: null,
                                  payout_memo: null)

data/docs/PayoutSummaryResponse.md

@@ -19,10 +19,10 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::PayoutSummaryResponse.new(payout_id: null,
-                                 status: null,
-                                 payments_submitted: null,
-                                 payments_accepted: null,
-                                 payments_rejected: null,
+                                 status: COMPLETED,
+                                 payments_submitted: 10,
+                                 payments_accepted: 10,
+                                 payments_rejected: 0,
                                  fx_summaries: null,
                                  accounts: null,
                                  rejected_payments: null)

data/docs/QuoteFxSummary.md

@@ -4,8 +4,8 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**rate** | **Object** |  | 
-**inverted_rate** | **Object** |  | [optional] 
+**rate** | **Float** |  | 
+**inverted_rate** | **Float** |  | [optional] 
 **creation_time** | **DateTime** |  | 
 **expiry_time** | **DateTime** |  | [optional] 
 **quote_id** | **String** |  | 
@@ -21,17 +21,17 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::QuoteFxSummary.new(rate: null,
-                                 inverted_rate: null,
+instance = VeloPayments::QuoteFxSummary.new(rate: 1.12,
+                                 inverted_rate: 1.12,
                                  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)
+                                 total_source_amount: 1234,
+                                 total_payment_amount: 1234,
+                                 source_currency: USD,
+                                 payment_currency: USD,
+                                 funding_status: FUNDED,
+                                 status: QUOTED)
 ```
 
 

data/docs/RejectedPayment.md

@@ -10,6 +10,7 @@ Name | Type | Description | Notes
 **source_account_name** | **String** |  | 
 **payor_payment_id** | **String** |  | 
 **reason** | **String** |  | 
+**reason_code** | **String** |  | [optional] 
 **line_number** | **Integer** |  | [optional] 
 **message** | **String** |  | [optional] 
 
@@ -18,14 +19,15 @@ Name | Type | Description | Notes
 ```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)
+instance = VeloPayments::RejectedPayment.new(remote_id: remoteIdVal123,
+                                 currency_type: USD,
+                                 amount: 1234,
+                                 source_account_name: Chase,
+                                 payor_payment_id: paymenIdVal123123,
+                                 reason: The payee has not been onboarded,
+                                 reason_code: PAYMENT_VALUE_TOO_HIGH,
+                                 line_number: 10,
+                                 message: Payment cannot be processed because of the Payee's OFAC or Compliance Status)
 ```
 
 

data/docs/SetNotificationsRequest.md

@@ -0,0 +1,17 @@
+# VeloPayments::SetNotificationsRequest
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**minimum_balance** | **Integer** | Amount to set as minimum balance in minor units | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SetNotificationsRequest.new(minimum_balance: null)
+```
+
+

data/docs/SourceAccount.md

@@ -14,10 +14,10 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::SourceAccount.new(source_account_name: null,
+instance = VeloPayments::SourceAccount.new(source_account_name: AccountName,
                                  source_account_id: null,
-                                 currency: null,
-                                 total_payout_cost: null)
+                                 currency: USD,
+                                 total_payout_cost: 1231200)
 ```
 
 

data/docs/SourceAccountResponse.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **id** | **String** | Source Account Id | [optional] 
-**balance** | **Object** | Decimal implied | [optional] 
+**balance** | **Integer** | Decimal implied | [optional] 
 **currency** | **String** |  | [optional] 
 **funding_ref** | **String** |  | [optional] 
 **physical_account_name** | **String** |  | [optional] 
@@ -16,6 +16,7 @@ Name | Type | Description | Notes
 **balance_visible** | **Boolean** |  | [optional] 
 **customer_id** | **String** |  | [optional] 
 **physical_account_id** | **String** |  | [optional] 
+**funding_account_id** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -23,17 +24,18 @@ Name | Type | Description | Notes
 require 'VeloPayments'
 
 instance = VeloPayments::SourceAccountResponse.new(id: null,
-                                 balance: null,
-                                 currency: null,
-                                 funding_ref: null,
-                                 physical_account_name: null,
-                                 rails_id: null,
+                                 balance: 1203489,
+                                 currency: USD,
+                                 funding_ref: a1b2c3d4,
+                                 physical_account_name: VELO_FBO_MYBANKA_USD,
+                                 rails_id: BOA_RAIL,
                                  payor_id: null,
-                                 name: null,
+                                 name: MyAccountName,
                                  pooled: null,
                                  balance_visible: null,
-                                 customer_id: null,
-                                 physical_account_id: null)
+                                 customer_id: Joe Customer,
+                                 physical_account_id: null,
+                                 funding_account_id: null)
 ```
 
 

data/docs/SourceAccountResponseV2.md

@@ -0,0 +1,45 @@
+# VeloPayments::SourceAccountResponseV2
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Source Account Id | 
+**balance** | **Integer** | Decimal implied | [optional] 
+**currency** | **String** |  | [optional] 
+**funding_ref** | **String** |  | 
+**physical_account_name** | **String** |  | 
+**rails_id** | **String** |  | 
+**payor_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**pooled** | **Boolean** |  | 
+**balance_visible** | **Boolean** |  | 
+**customer_id** | **String** |  | [optional] 
+**physical_account_id** | **String** |  | [optional] 
+**notifications** | [**Notifications**](Notifications.md) |  | [optional] 
+**funding_account_id** | **String** |  | [optional] 
+**auto_top_up_config** | [**AutoTopUpConfig**](AutoTopUpConfig.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::SourceAccountResponseV2.new(id: null,
+                                 balance: 1203489,
+                                 currency: USD,
+                                 funding_ref: a1b2c3d4,
+                                 physical_account_name: VELO_FBO_MYBANKA_USD,
+                                 rails_id: BOA_RAIL,
+                                 payor_id: null,
+                                 name: MyAccountName,
+                                 pooled: null,
+                                 balance_visible: null,
+                                 customer_id: Joe Customer,
+                                 physical_account_id: null,
+                                 notifications: null,
+                                 funding_account_id: null,
+                                 auto_top_up_config: null)
+```
+
+

data/docs/SourceAccountSummaryV3.md

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