velopayments 2.14.90.pre.1 → 2.17.8.beta1

data/docs/PaymentAuditServiceApi.md

@@ -12,6 +12,7 @@ Method | HTTP request | Description
 [**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_payment_changes**](PaymentAuditServiceApi.md#list_payment_changes) | **GET** /v1/deltas/payments | List Payment Changes
 [**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
 
@@ -38,9 +39,10 @@ end
 
 api_instance = VeloPayments::PaymentAuditServiceApi.new
 opts = {
-  payor_id: 'payor_id_example', # String | The account owner Payor ID
+  payor_id: 'payor_id_example', # String | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. 
   start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
-  submitted_date_from: Date.parse('2013-10-20') # Date | Start date, inclusive. Format is YYYY-MM-DD
+  submitted_date_from: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
+  include: 'include_example' # String | Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.                      Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id 
 }
 
 begin
@@ -57,9 +59,10 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | [optional] 
+ **payor_id** | [**String**](.md)| The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.  | [optional] 
  **start_date** | **Date**| Start date, inclusive. Format is YYYY-MM-DD | [optional] 
  **submitted_date_from** | **Date**| Start date, inclusive. Format is YYYY-MM-DD | [optional] 
+ **include** | **String**| Mode to determine whether to include other Payor's data in the results. May only be used if payorId is specified. Can be omitted or set to 'payorOnly' or 'payorAndDescendants'. payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted. payorAndDescendants: Aggregate results for all descendant Payors of the specified Payor. Should only be used if the Payor with the specified payorId has at least one child Payor.                      Note when a Payor requests the report and include=payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id  | [optional] 
 
 ### Return type
 
@@ -539,6 +542,66 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
+## list_payment_changes
+
+> PaymentDeltaResponse list_payment_changes(payor_id, updated_since, opts)
+
+List Payment Changes
+
+Get a paginated response listing payment changes.
+
+### 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 Payor ID to find associated Payments
+updated_since = DateTime.parse('2013-10-20T19:20:30+01:00') # DateTime | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
+opts = {
+  page: 1, # Integer | Page number. Default is 1.
+  page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000.
+}
+
+begin
+  #List Payment Changes
+  result = api_instance.list_payment_changes(payor_id, updated_since, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PaymentAuditServiceApi->list_payment_changes: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The Payor ID to find associated Payments | 
+ **updated_since** | **DateTime**| The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm | 
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+ **page_size** | **Integer**| Page size. Default is 100. Max allowable is 1000. | [optional] [default to 100]
+
+### Return type
+
+[**PaymentDeltaResponse**](PaymentDeltaResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_payments_audit
 
 > ListPaymentsResponse list_payments_audit(opts)
@@ -571,7 +634,7 @@ opts = {
   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.
+  payment_currency: 'payment_currency_example', # String | The payment 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.
@@ -606,7 +669,7 @@ Name | Type | Description  | Notes
  **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] 
+ **payment_currency** | **String**| The payment 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] 
@@ -661,7 +724,7 @@ opts = {
   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.
+  payment_currency: 'payment_currency_example', # String | The payment 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.
@@ -696,7 +759,7 @@ Name | Type | Description  | Notes
  **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] 
+ **payment_currency** | **String**| The payment 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] 

data/docs/PaymentDelta.md

@@ -0,0 +1,31 @@
+# VeloPayments::PaymentDelta
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** |  | [readonly] 
+**payout_id** | **String** |  | [readonly] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_currency** | **String** |  | [optional] 
+**payment_amount** | **Integer** |  | [optional] 
+**status** | [**PaymentStatus**](PaymentStatus.md) |  | [optional] 
+**source_currency** | **String** |  | [optional] 
+**source_amount** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentDelta.new(payment_id: null,
+                                 payout_id: null,
+                                 payor_payment_id: null,
+                                 payment_currency: null,
+                                 payment_amount: null,
+                                 status: null,
+                                 source_currency: null,
+                                 source_amount: null)
+```
+
+

data/docs/PaymentDeltaResponse.md

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

data/docs/PaymentResponseV4.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **payment_id** | **String** |  | 
 **payee_id** | **String** |  | 
-**payor_id** | **String** |  | 
+**payor_id** | **String** | Deprecated in v2.16. Will be populated with submitting payor ID until removed in a later release. | 
 **payor_name** | **String** |  | [optional] 
 **quote_id** | **String** |  | 
 **source_account_id** | **String** |  | 
@@ -37,6 +37,7 @@ Name | Type | Description | Notes
 **events** | [**Array<PaymentEventResponseV4>**](PaymentEventResponseV4.md) |  | 
 **return_cost** | **Integer** |  | [optional] 
 **return_reason** | **String** |  | [optional] 
+**payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) |  | [optional] 
 
 ## Code Sample
 
@@ -75,7 +76,8 @@ instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  country_code: null,
                                  events: null,
                                  return_cost: null,
-                                 return_reason: null)
+                                 return_reason: null,
+                                 payout: null)
 ```
 
 

data/docs/PaymentResponseV4Payout.md

@@ -0,0 +1,19 @@
+# VeloPayments::PaymentResponseV4Payout
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payout_from** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
+**payout_to** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentResponseV4Payout.new(payout_from: null,
+                                 payout_to: null)
+```
+
+

data/docs/PaymentStatus.md

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

data/docs/PayorAddress.md

@@ -0,0 +1,31 @@
+# VeloPayments::PayorAddress
+
+## 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** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorAddress.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/PayorAddressV2.md

@@ -0,0 +1,31 @@
+# VeloPayments::PayorAddressV2
+
+## 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** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorAddressV2.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/PayorV1.md

@@ -4,26 +4,27 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payor_id** | **String** |  | [optional] 
+**payor_id** | **String** |  | [optional] [readonly] 
 **payor_name** | **String** | The name of the payor. | 
-**address** | [**Address**](Address.md) |  | [optional] 
+**address** | [**PayorAddress**](PayorAddress.md) |  | [optional] 
 **primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] 
 **primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] 
 **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] 
 **funding_account_routing_number** | **String** | The funding account routing number to be used for the payor. | [optional] 
 **funding_account_account_number** | **String** | The funding account number to be used for the payor. | [optional] 
 **funding_account_account_name** | **String** | The funding account name to be used for the payor. | [optional] 
-**kyc_state** | **String** | The kyc state of the payor. | [optional] 
+**kyc_state** | **String** | The kyc state of the payor. | [optional] [readonly] 
 **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] 
-**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] 
-**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] 
+**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] [readonly] 
+**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] [readonly] 
 **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] 
 **support_contact** | **String** | The payor’s support contact email address. | [optional] 
 **dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] 
 **allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] 
-**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] 
+**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] [readonly] 
 **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
 **includes_reports** | **Boolean** |  | [optional] 
+**max_master_payor_admins** | **Integer** |  | [optional] 
 
 ## Code Sample
 
@@ -49,7 +50,8 @@ instance = VeloPayments::PayorV1.new(payor_id: null,
                                  allows_language_choice: null,
                                  reminder_emails_opt_out: null,
                                  language: EN,
-                                 includes_reports: null)
+                                 includes_reports: null,
+                                 max_master_payor_admins: null)
 ```
 
 

data/docs/PayorV2.md

@@ -4,23 +4,24 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payor_id** | **String** |  | [optional] 
+**payor_id** | **String** |  | [optional] [readonly] 
 **payor_name** | **String** | The name of the payor. | 
-**address** | [**Address**](Address.md) |  | [optional] 
+**address** | [**PayorAddressV2**](PayorAddressV2.md) |  | [optional] 
 **primary_contact_name** | **String** | Name of primary contact for the payor. | [optional] 
 **primary_contact_phone** | **String** | Primary contact phone number for the payor. | [optional] 
 **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] 
-**kyc_state** | **String** | The kyc state of the payor. | [optional] 
+**kyc_state** | **String** | The kyc state of the payor. | [optional] [readonly] 
 **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] 
-**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] 
-**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] 
+**payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] [readonly] 
+**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] [readonly] 
 **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] 
 **support_contact** | **String** | The payor’s support contact email address. | [optional] 
 **dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] 
 **allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] 
-**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] 
+**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] [readonly] 
 **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
 **includes_reports** | **Boolean** |  | [optional] 
+**max_master_payor_admins** | **Integer** |  | [optional] 
 
 ## Code Sample
 
@@ -43,7 +44,8 @@ instance = VeloPayments::PayorV2.new(payor_id: null,
                                  allows_language_choice: null,
                                  reminder_emails_opt_out: null,
                                  language: EN,
-                                 includes_reports: null)
+                                 includes_reports: null,
+                                 max_master_payor_admins: null)
 ```
 
 

data/docs/PayorsApi.md

@@ -279,7 +279,7 @@ Name | Type | Description  | Notes
 
 ## payor_links
 
-> PayorLinksResponse payor_links(descendants_of_payor, opts)
+> PayorLinksResponse payor_links(opts)
 
 List Payor Links
 
@@ -297,14 +297,15 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-descendants_of_payor = 'descendants_of_payor_example' # String | The Payor ID from which to start the query to show all descendants
 opts = {
-  fields: 'fields_example' # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState              
+  descendants_of_payor: 'descendants_of_payor_example', # String | The Payor ID from which to start the query to show all descendants
+  parent_of_payor: 'parent_of_payor_example', # String | Look for the parent payor details for this payor id
+  fields: 'fields_example' # String | List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState 
 }
 
 begin
   #List Payor Links
-  result = api_instance.payor_links(descendants_of_payor, opts)
+  result = api_instance.payor_links(opts)
   p result
 rescue VeloPayments::ApiError => e
   puts "Exception when calling PayorsApi->payor_links: #{e}"
@@ -316,8 +317,9 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **descendants_of_payor** | [**String**](.md)| The Payor ID from which to start the query to show all descendants | 
- **fields** | **String**| List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState               | [optional] 
+ **descendants_of_payor** | [**String**](.md)| The Payor ID from which to start the query to show all descendants | [optional] 
+ **parent_of_payor** | [**String**](.md)| Look for the parent payor details for this payor id | [optional] 
+ **fields** | **String**| List of additional Payor fields to include in the response for each Payor. The values of payorId and payorName and always included for each Payor - 'fields' allows you to add to this. Example: ```fields=primaryContactEmail,kycState``` - will include payorId+payorName+primaryContactEmail+kycState for each Payor Default if not specified is to include only payorId and payorName. The supported fields are any combination of: primaryContactEmail,kycState  | [optional] 
 
 ### Return type
 

data/docs/PayoutPayorV4.md

@@ -0,0 +1,25 @@
+# VeloPayments::PayoutPayorV4
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** | The id of the payor. | 
+**payor_name** | **String** | The name of the payor. | 
+**dba_name** | **String** | The alternate name of the payor. | 
+**principal** | **String** | Email address if principal is a user or ID if application. | 
+**principal_id** | **String** | The id of the principal. | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutPayorV4.new(payor_id: null,
+                                 payor_name: null,
+                                 dba_name: null,
+                                 principal: null,
+                                 principal_id: null)
+```
+
+