velopayments 2.11.73 → 2.14.90.pre.1

data/docs/PaymentAuditCurrencyV3.md

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

data/docs/PaymentAuditCurrencyV4.md

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

data/docs/PaymentAuditServiceApi.md

@@ -7,9 +7,13 @@ Method | HTTP request | Description
 [**export_transactions_csv**](PaymentAuditServiceApi.md#export_transactions_csv) | **GET** /v4/paymentaudit/transactions | Export Transactions
 [**get_fundings**](PaymentAuditServiceApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
 [**get_payment_details**](PaymentAuditServiceApi.md#get_payment_details) | **GET** /v3/paymentaudit/payments/{paymentId} | Get Payment
+[**get_payment_details_v4**](PaymentAuditServiceApi.md#get_payment_details_v4) | **GET** /v4/paymentaudit/payments/{paymentId} | Get Payment
 [**get_payments_for_payout**](PaymentAuditServiceApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
+[**get_payments_for_payout_v4**](PaymentAuditServiceApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
 [**get_payouts_for_payor**](PaymentAuditServiceApi.md#get_payouts_for_payor) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
+[**get_payouts_for_payor_v4**](PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor
 [**list_payments_audit**](PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
+[**list_payments_audit_v4**](PaymentAuditServiceApi.md#list_payments_audit_v4) | **GET** /v4/paymentaudit/payments | Get List of Payments
 
 
 
@@ -133,7 +137,7 @@ Name | Type | Description  | Notes
 
 ## get_payment_details
 
-> PaymentResponse get_payment_details(payment_id, opts)
+> PaymentResponseV3 get_payment_details(payment_id, opts)
 
 Get Payment
 
@@ -175,7 +179,63 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**PaymentResponse**](PaymentResponse.md)
+[**PaymentResponseV3**](PaymentResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payment_details_v4
+
+> PaymentResponseV4 get_payment_details_v4(payment_id, opts)
+
+Get Payment
+
+Get the payment with the given id. This contains the payment history. 
+
+### 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::PaymentAuditServiceApi.new
+payment_id = 'payment_id_example' # String | Payment Id
+opts = {
+  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 Payment
+  result = api_instance.get_payment_details_v4(payment_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PaymentAuditServiceApi->get_payment_details_v4: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_id** | [**String**](.md)| Payment Id | 
+ **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
+
+[**PaymentResponseV4**](PaymentResponseV4.md)
 
 ### Authorization
 
@@ -189,7 +249,7 @@ Name | Type | Description  | Notes
 
 ## get_payments_for_payout
 
-> GetPaymentsForPayoutResponse get_payments_for_payout(payout_id, opts)
+> GetPaymentsForPayoutResponseV3 get_payments_for_payout(payout_id, opts)
 
 Get Payments for Payout
 
@@ -253,7 +313,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::PaymentAuditServiceApi.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 PaymentAuditServiceApi->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
 
@@ -267,7 +405,7 @@ Name | Type | Description  | Notes
 
 ## get_payouts_for_payor
 
-> GetPayoutsResponse get_payouts_for_payor(payor_id, opts)
+> GetPayoutsResponseV3 get_payouts_for_payor(payor_id, opts)
 
 Get Payouts for Payor
 
@@ -321,7 +459,75 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**GetPayoutsResponse**](GetPayoutsResponse.md)
+[**GetPayoutsResponseV3**](GetPayoutsResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payouts_for_payor_v4
+
+> GetPayoutsResponseV4 get_payouts_for_payor_v4(payor_id, opts)
+
+Get Payouts for Payor
+
+Get List of payouts for payor 
+
+### 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::PaymentAuditServiceApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+opts = {
+  payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
+  status: 'status_example', # String | Payout Status
+  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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. 
+}
+
+begin
+  #Get Payouts for Payor
+  result = api_instance.get_payouts_for_payor_v4(payor_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PaymentAuditServiceApi->get_payouts_for_payor_v4: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payout_memo** | **String**| Payout Memo filter - case insensitive sub-string match | [optional] 
+ **status** | **String**| Payout Status | [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,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.  | [optional] 
+
+### Return type
+
+[**GetPayoutsResponseV4**](GetPayoutsResponseV4.md)
 
 ### Authorization
 
@@ -422,3 +628,93 @@ Name | Type | Description  | Notes
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
+
+## list_payments_audit_v4
+
+> ListPaymentsResponse list_payments_audit_v4(opts)
+
+Get List of Payments
+
+Get payments for the given payor Id
+
+### 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::PaymentAuditServiceApi.new
+opts = {
+  payee_id: 'payee_id_example', # String | The UUID of the payee.
+  payor_id: 'payor_id_example', # String | The account owner Payor Id. Required for external users.
+  payor_name: 'payor_name_example', # String | The payor’s name. This filters via a case insensitive substring match.
+  remote_id: 'remote_id_example', # String | The remote id of the payees.
+  status: 'status_example', # String | Payment Status
+  source_account_name: 'source_account_name_example', # String | The source account name filter. This filters via a case insensitive substring match.
+  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
+  source_currency: 'source_currency_example', # String | The source currency filter. Filters based on an exact match on the currency.
+  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
+  payment_currency: 'payment_currency_example', # String | The source currency filter. Filters based on an exact match on the currency.
+  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.
+  payment_memo: 'payment_memo_example', # String | The payment memo filter. This filters via a case insensitive substring match.
+  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 List of Payments
+  result = api_instance.list_payments_audit_v4(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PaymentAuditServiceApi->list_payments_audit_v4: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payee_id** | [**String**](.md)| The UUID of the payee. | [optional] 
+ **payor_id** | [**String**](.md)| The account owner Payor Id. Required for external users. | [optional] 
+ **payor_name** | **String**| The payor’s name. This filters via a case insensitive substring match. | [optional] 
+ **remote_id** | **String**| The remote id of the payees. | [optional] 
+ **status** | **String**| Payment Status | [optional] 
+ **source_account_name** | **String**| The source account name filter. This filters via a case insensitive substring match. | [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] 
+ **source_currency** | **String**| The source currency filter. Filters based on an exact match on the currency. | [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] 
+ **payment_currency** | **String**| The source currency filter. Filters based on an exact match on the currency. | [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] 
+ **payment_memo** | **String**| The payment memo filter. This filters via a case insensitive substring match. | [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
+
+[**ListPaymentsResponse**](ListPaymentsResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PaymentEventResponseV3.md

@@ -0,0 +1,39 @@
+# VeloPayments::PaymentEventResponseV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**event_id** | **String** | The id of the event. | 
+**event_date_time** | **DateTime** | The date/time at which the event occurred. | 
+**event_type** | **String** | The type of the event. | 
+**source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**source_amount** | **Integer** | The source amount exposed by the event. | [optional] 
+**payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
+**payment_amount** | **Integer** | The destination amount exposed by the event. | [optional] 
+**account_number** | **String** | The account number attached to the event. | [optional] 
+**routing_number** | **String** | The routing number attached to the event. | [optional] 
+**iban** | **String** |  | [optional] 
+**account_name** | **String** |  | [optional] 
+**principal** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentEventResponseV3.new(event_id: null,
+                                 event_date_time: null,
+                                 event_type: null,
+                                 source_currency: null,
+                                 source_amount: 1299,
+                                 payment_currency: null,
+                                 payment_amount: 1299,
+                                 account_number: 123123123,
+                                 routing_number: 123123123,
+                                 iban: DE89 3704 0044 0532 0130 00,
+                                 account_name: My account,
+                                 principal: Prinicple example)
+```
+
+

data/docs/{PaymentEventResponse.md → PaymentEventResponseV4.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PaymentEventResponse
+# VeloPayments::PaymentEventResponseV4
 
 ## Properties
 
@@ -7,10 +7,10 @@ Name | Type | Description | Notes
 **event_id** | **String** | The id of the event. | 
 **event_date_time** | **DateTime** | The date/time at which the event occurred. | 
 **event_type** | **String** | The type of the event. | 
-**source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
-**source_amount** | **Float** | The source amount exposed by the event. | [optional] 
-**payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
-**payment_amount** | **Float** | The destination amount exposed by the event. | [optional] 
+**source_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
+**source_amount** | **Integer** | The source amount exposed by the event. | [optional] 
+**payment_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
+**payment_amount** | **Integer** | The destination amount exposed by the event. | [optional] 
 **account_number** | **String** | The account number attached to the event. | [optional] 
 **routing_number** | **String** | The routing number attached to the event. | [optional] 
 **iban** | **String** |  | [optional] 
@@ -22,13 +22,13 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentEventResponse.new(event_id: null,
+instance = VeloPayments::PaymentEventResponseV4.new(event_id: null,
                                  event_date_time: null,
                                  event_type: null,
                                  source_currency: null,
-                                 source_amount: null,
+                                 source_amount: 1299,
                                  payment_currency: null,
-                                 payment_amount: null,
+                                 payment_amount: 1299,
                                  account_number: null,
                                  routing_number: null,
                                  iban: null,