RubyGems - velopayments - Versions diffs - 2.26.124.beta1 → 2.29.128.beta1 - Mend

velopayments 2.26.124.beta1 → 2.29.128.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (612) hide show

data/docs/PayeesApi.md CHANGED Viewed

@@ -38,7 +38,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 begin
   # Delete Payee by Id
@@ -70,7 +70,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 ### Return type
@@ -106,7 +106,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 begin
   # Delete Payee by Id
@@ -138,7 +138,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 ### Return type
@@ -174,7 +174,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 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.
 }
@@ -210,7 +210,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **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
@@ -247,7 +247,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 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.
 }
@@ -283,7 +283,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **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
@@ -320,7 +320,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payor_id = TODO # String | The Payor ID to find associated Payees
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payees
 updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
 opts = {
   page: 1, # Integer | Page number. Default is 1.
@@ -358,7 +358,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor ID to find associated Payees |  |
+| **payor_id** | **String** | The Payor ID to find associated Payees |  |
 | **updated_since** | **Time** | 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] |
@@ -397,7 +397,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payor_id = TODO # String | The Payor ID to find associated Payees
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payees
 updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
 opts = {
   page: 1, # Integer | Page number. Default is 1.
@@ -435,7 +435,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor ID to find associated Payees |  |
+| **payor_id** | **String** | The Payor ID to find associated Payees |  |
 | **updated_since** | **Time** | 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] |
@@ -474,15 +474,15 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payor_id = TODO # String | The account owner Payor ID
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   watchlist_status: VeloPayments::WatchlistStatus::NONE, # WatchlistStatus | The watchlistStatus of the payees.
   disabled: true, # Boolean | Payee disabled
   onboarded_status: VeloPayments::OnboardedStatus::CREATED, # OnboardedStatus | The onboarded status of the payees.
-  email: TODO, # String | Email address
+  email: 'bob@example.com', # String | Email address
   display_name: 'Bob Smith', # String | The display name of the payees.
   remote_id: 'remoteId123', # String | The remote id of the payees.
-  payee_type: VeloPayments::PayeeType::INDIVIDUAL, # PayeeType | The onboarded status of the payees.
+  payee_type: VeloPayments::PayeeType2::INDIVIDUAL, # PayeeType2 | The onboarded status of the payees.
   payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
   page: 1, # Integer | Page number. Default is 1.
   page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
@@ -520,14 +520,14 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **watchlist_status** | [**WatchlistStatus**](.md) | The watchlistStatus of the payees. | [optional] |
 | **disabled** | **Boolean** | Payee disabled | [optional] |
 | **onboarded_status** | [**OnboardedStatus**](.md) | The onboarded status of the payees. | [optional] |
-| **email** | [**String**](.md) | Email address | [optional] |
+| **email** | **String** | Email address | [optional] |
 | **display_name** | **String** | The display name of the payees. | [optional] |
 | **remote_id** | **String** | The remote id of the payees. | [optional] |
-| **payee_type** | [**PayeeType**](.md) | The onboarded status of the payees. | [optional] |
+| **payee_type** | [**PayeeType2**](.md) | The onboarded status of the payees. | [optional] |
 | **payee_country** | **String** | The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [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] |
@@ -567,15 +567,15 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payor_id = TODO # String | The account owner Payor ID
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   watchlist_status: VeloPayments::WatchlistStatus::NONE, # WatchlistStatus | The watchlistStatus of the payees.
   disabled: true, # Boolean | Payee disabled
   onboarded_status: VeloPayments::OnboardedStatus::CREATED, # OnboardedStatus | The onboarded status of the payees.
-  email: TODO, # String | Email address
+  email: 'bob@example.com', # String | Email address
   display_name: 'Bob Smith', # String | The display name of the payees.
   remote_id: 'remoteId123', # String | The remote id of the payees.
-  payee_type: VeloPayments::PayeeType::INDIVIDUAL, # PayeeType | The onboarded status of the payees.
+  payee_type: VeloPayments::PayeeType2::INDIVIDUAL, # PayeeType2 | The onboarded status of the payees.
   payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case)
   ofac_status: VeloPayments::OfacStatus::PENDING, # OfacStatus | The ofacStatus of the payees.
   page: 1, # Integer | Page number. Default is 1.
@@ -614,14 +614,14 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **watchlist_status** | [**WatchlistStatus**](.md) | The watchlistStatus of the payees. | [optional] |
 | **disabled** | **Boolean** | Payee disabled | [optional] |
 | **onboarded_status** | [**OnboardedStatus**](.md) | The onboarded status of the payees. | [optional] |
-| **email** | [**String**](.md) | Email address | [optional] |
+| **email** | **String** | Email address | [optional] |
 | **display_name** | **String** | The display name of the payees. | [optional] |
 | **remote_id** | **String** | The remote id of the payees. | [optional] |
-| **payee_type** | [**PayeeType**](.md) | The onboarded status of the payees. | [optional] |
+| **payee_type** | [**PayeeType2**](.md) | The onboarded status of the payees. | [optional] |
 | **payee_country** | **String** | The country of the payee - 2 letter ISO 3166-1 country code (upper case) | [optional] |
 | **ofac_status** | [**OfacStatus**](.md) | The ofacStatus of the payees. | [optional] |
 | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
@@ -662,7 +662,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 update_payee_details_request = VeloPayments::UpdatePayeeDetailsRequest.new # UpdatePayeeDetailsRequest | Request to update payee details
 begin
@@ -695,7 +695,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **update_payee_details_request** | [**UpdatePayeeDetailsRequest**](UpdatePayeeDetailsRequest.md) | Request to update payee details |  |
 ### Return type
@@ -718,7 +718,7 @@ nil (empty response body)
 Update Payee Details
-<p>Update payee details for the given Payee Id.<p>
+<p>Update payee details for the given Payee Id.</p> <p>Payors may only update the payee details if the payee has not yet onboarded</p>
 ### Examples
@@ -732,7 +732,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 update_payee_details_request2 = VeloPayments::UpdatePayeeDetailsRequest2.new # UpdatePayeeDetailsRequest2 | Request to update payee details
 begin
@@ -765,7 +765,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **update_payee_details_request2** | [**UpdatePayeeDetailsRequest2**](UpdatePayeeDetailsRequest2.md) | Request to update payee details |  |
 ### Return type
@@ -802,7 +802,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 update_remote_id_request = VeloPayments::UpdateRemoteIdRequest.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', remote_id: 'remoteId123'}) # UpdateRemoteIdRequest | Request to update payee remote id v3
 begin
@@ -835,7 +835,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **update_remote_id_request** | [**UpdateRemoteIdRequest**](UpdateRemoteIdRequest.md) | Request to update payee remote id v3 |  |
 ### Return type
@@ -872,7 +872,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayeesApi.new
-payee_id = TODO # String | The UUID of the payee.
+payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
 update_remote_id_request2 = VeloPayments::UpdateRemoteIdRequest2.new({payor_id: '9ac75325-5dcd-42d5-b992-175d7e0a035e', remote_id: 'remoteId123'}) # UpdateRemoteIdRequest2 | Request to update payee remote id v4
 begin
@@ -905,7 +905,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payee_id** | [**String**](.md) | The UUID of the payee. |  |
+| **payee_id** | **String** | The UUID of the payee. |  |
 | **update_remote_id_request2** | [**UpdateRemoteIdRequest2**](UpdateRemoteIdRequest2.md) | Request to update payee remote id v4 |  |
 ### Return type

data/docs/PaymentAuditServiceApi.md CHANGED Viewed

@@ -35,7 +35,7 @@ end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
 opts = {
-  payor_id: TODO, # String | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | <p>The Payor ID for whom you wish to run the report.</p> <p>For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.</p>
   start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
   end_date: Date.parse('2013-10-20'), # Date | End date, inclusive. Format is YYYY-MM-DD
   include: 'payorOnly' # String | <p>Mode to determine whether to include other Payor's data in the results.</p> <p>May only be used if payorId is specified.</p> <p>Can be omitted or set to 'payorOnly' or 'payorAndDescendants'.</p> <p>payorOnly: Only include results for the specified Payor. This is the default if 'include' is omitted.</p> <p>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.</p> <p>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</p>
@@ -72,7 +72,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | &lt;p&gt;The Payor ID for whom you wish to run the report.&lt;/p&gt; &lt;p&gt;For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.&lt;/p&gt;  | [optional] |
+| **payor_id** | **String** | &lt;p&gt;The Payor ID for whom you wish to run the report.&lt;/p&gt; &lt;p&gt;For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.&lt;/p&gt;  | [optional] |
 | **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
 | **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
 | **include** | **String** | &lt;p&gt;Mode to determine whether to include other Payor&#39;s data in the results.&lt;/p&gt; &lt;p&gt;May only be used if payorId is specified.&lt;/p&gt; &lt;p&gt;Can be omitted or set to &#39;payorOnly&#39; or &#39;payorAndDescendants&#39;.&lt;/p&gt; &lt;p&gt;payorOnly: Only include results for the specified Payor. This is the default if &#39;include&#39; is omitted.&lt;/p&gt; &lt;p&gt;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.&lt;/p&gt; &lt;p&gt;Note when a Payor requests the report and include&#x3D;payorAndDescendants is used, the following additional columns are included in the CSV: Payor Name, Payor Id&lt;/p&gt;  | [optional] |
@@ -111,7 +111,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
-payor_id = TODO # String | The account owner Payor ID
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   page: 56, # Integer | Page number. Default is 1.
   page_size: 56, # Integer | The number of results to return in a page
@@ -149,7 +149,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
 | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
 | **sort** | **String** | List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.  | [optional] |
@@ -188,7 +188,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
-payment_id = TODO # String | Payment Id
+payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # 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.
 }
@@ -224,7 +224,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payment_id** | [**String**](.md) | Payment Id |  |
+| **payment_id** | **String** | 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
@@ -261,7 +261,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
-payout_id = TODO # String | The id (UUID) of the payout.
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id (UUID) of the payout.
 opts = {
   remote_id: 'remote_id_example', # String | The remote id of the payees.
   remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
@@ -310,7 +310,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | The id (UUID) of the payout. |  |
+| **payout_id** | **String** | The id (UUID) of the payout. |  |
 | **remote_id** | **String** | The remote id of the payees. | [optional] |
 | **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
 | **status** | **String** | Payment Status | [optional] |
@@ -361,7 +361,7 @@ end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
 opts = {
-  payor_id: TODO # String | The account owner Payor ID. Required for external users.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID. Required for external users.
 }
 begin
@@ -395,7 +395,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID. Required for external users. | [optional] |
+| **payor_id** | **String** | The account owner Payor ID. Required for external users. | [optional] |
 ### Return type
@@ -432,15 +432,18 @@ end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
 opts = {
-  payor_id: TODO, # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
   payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
   status: 'ACCEPTED', # 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.
   from_payor_name: 'from_payor_name_example', # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
+  scheduled_for_date_from: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
+  scheduled_for_date_to: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
+  schedule_status: 'ANY', # String | Payout Schedule Status
   page: 56, # Integer | Page number. Default is 1.
   page_size: 56, # Integer | The number of results to return in a page
-  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, totalPayments, payoutId
+  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, totalPayments, payoutId, scheduledFor
 }
 begin
@@ -474,15 +477,18 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] |
+| **payor_id** | **String** | The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] |
 | **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] |
 | **from_payor_name** | **String** | The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional] |
+| **scheduled_for_date_from** | **Date** | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. | [optional] |
+| **scheduled_for_date_to** | **Date** | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. | [optional] |
+| **schedule_status** | **String** | Payout Schedule Status | [optional] |
 | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
 | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
-| **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId  | [optional] |
+| **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments, payoutId, scheduledFor  | [optional] |
 ### Return type
@@ -518,7 +524,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
-payor_id = TODO # String | The Payor ID to find associated Payments
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payments
 updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
 opts = {
   page: 56, # Integer | Page number. Default is 1.
@@ -556,7 +562,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor ID to find associated Payments |  |
+| **payor_id** | **String** | The Payor ID to find associated Payments |  |
 | **updated_since** | **Time** | 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** | The number of results to return in a page | [optional][default to 100] |
@@ -596,8 +602,8 @@ end
 api_instance = VeloPayments::PaymentAuditServiceApi.new
 opts = {
-  payee_id: TODO, # String | The UUID of the payee.
-  payor_id: TODO, # String | The account owner Payor Id. Required for external users.
+  payee_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The UUID of the payee.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # 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.
   remote_system_id: 'remote_system_id_example', # String | The id of the remote system that is orchestrating payments
@@ -613,6 +619,9 @@ opts = {
   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.
+  scheduled_for_date_from: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd.
+  scheduled_for_date_to: Date.parse('2013-10-20'), # Date | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd.
+  schedule_status: 'ANY', # String | Payout Schedule Status
   page: 56, # Integer | Page number. Default is 1.
   page_size: 56, # Integer | The number of results to return in a page
   sort: 'sort_example', # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId
@@ -650,8 +659,8 @@ end
 | 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] |
+| **payee_id** | **String** | The UUID of the payee. | [optional] |
+| **payor_id** | **String** | 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] |
 | **remote_system_id** | **String** | The id of the remote system that is orchestrating payments | [optional] |
@@ -667,6 +676,9 @@ end
 | **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] |
+| **scheduled_for_date_from** | **Date** | Filter payouts scheduled to run on or after the given date. Format is yyyy-MM-dd. | [optional] |
+| **scheduled_for_date_to** | **Date** | Filter payouts scheduled to run on or before the given date. Format is yyyy-MM-dd. | [optional] |
+| **schedule_status** | **String** | Payout Schedule Status | [optional] |
 | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
 | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
 | **sort** | **String** | List of sort fields (e.g. ?sort&#x3D;submittedDateTime:asc,status:asc). Default is sort by submittedDateTime:desc,paymentId:asc The supported sort fields are: sourceAmount, sourceCurrency, paymentAmount, paymentCurrency, routingNumber, accountNumber, remoteId, submittedDateTime, status and paymentId  | [optional] |

data/docs/PaymentAuditServiceDeprecatedApi.md CHANGED Viewed

@@ -35,7 +35,7 @@ end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
 opts = {
-  payor_id: TODO, # 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.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # 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
   end_date: Date.parse('2013-10-20') # Date | End date, inclusive. Format is YYYY-MM-DD
 }
@@ -71,7 +71,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
+| **payor_id** | **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.  | [optional] |
 | **start_date** | **Date** | Start date, inclusive. Format is YYYY-MM-DD | [optional] |
 | **end_date** | **Date** | End date, inclusive. Format is YYYY-MM-DD | [optional] |
@@ -109,7 +109,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
-payor_id = TODO # String | The account owner Payor ID
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   page: 56, # Integer | Page number. Default is 1.
   page_size: 56, # Integer | The number of results to return in a page
@@ -147,7 +147,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **page** | **Integer** | Page number. Default is 1. | [optional][default to 1] |
 | **page_size** | **Integer** | The number of results to return in a page | [optional][default to 25] |
 | **sort** | **String** | List of sort fields. Example: &#x60;&#x60;&#x60;?sort&#x3D;destinationCurrency:asc,destinationAmount:asc&#x60;&#x60;&#x60; Default is no sort. The supported sort fields are: dateTime and amount.  | [optional] |
@@ -186,7 +186,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
-payment_id = TODO # String | Payment Id
+payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # 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.
 }
@@ -222,7 +222,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payment_id** | [**String**](.md) | Payment Id |  |
+| **payment_id** | **String** | 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
@@ -259,7 +259,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
-payout_id = TODO # String | The id (UUID) of the payout.
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The id (UUID) of the payout.
 opts = {
   remote_id: 'remote_id_example', # String | The remote id of the payees.
   status: 'ACCEPTED', # String | Payment Status
@@ -306,7 +306,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | The id (UUID) of the payout. |  |
+| **payout_id** | **String** | 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 &gt;&#x3D; sourceAmountFrom | [optional] |
@@ -355,7 +355,7 @@ end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
 opts = {
-  payor_id: TODO # String | The account owner Payor ID. Required for external users.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID. Required for external users.
 }
 begin
@@ -389,7 +389,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID. Required for external users. | [optional] |
+| **payor_id** | **String** | The account owner Payor ID. Required for external users. | [optional] |
 ### Return type
@@ -425,7 +425,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
-payor_id = TODO # String | The account owner Payor ID
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
   status: 'ACCEPTED', # String | Payout Status
@@ -467,7 +467,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The account owner Payor ID |  |
+| **payor_id** | **String** | 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] |
@@ -510,7 +510,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
-payor_id = TODO # String | The Payor ID to find associated Payments
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payments
 updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm
 opts = {
   page: 56, # Integer | Page number. Default is 1.
@@ -548,7 +548,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor ID to find associated Payments |  |
+| **payor_id** | **String** | The Payor ID to find associated Payments |  |
 | **updated_since** | **Time** | 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** | The number of results to return in a page | [optional][default to 100] |
@@ -588,8 +588,8 @@ end
 api_instance = VeloPayments::PaymentAuditServiceDeprecatedApi.new
 opts = {
-  payee_id: TODO, # String | The UUID of the payee.
-  payor_id: TODO, # String | The account owner Payor Id. Required for external users.
+  payee_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The UUID of the payee.
+  payor_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # 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: 'ACCEPTED', # String | Payment Status
@@ -640,8 +640,8 @@ end
 | 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] |
+| **payee_id** | **String** | The UUID of the payee. | [optional] |
+| **payor_id** | **String** | 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] |

data/docs/PaymentResponseV4.md CHANGED Viewed

@@ -45,9 +45,11 @@
 | **rejection_reason** | **String** |  | [optional] |
 | **withdrawn_reason** | **String** |  | [optional] |
 | **withdrawable** | **Boolean** |  | [optional] |
+| **auto_withdrawn_reason_code** | **String** | Populated with rejection reason code if the payment was withdrawn automatically at instruct time | [optional] |
 | **transmission_type** | **String** | The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE | [optional] |
 | **payment_tracking_reference** | **String** |  | [optional] |
 | **payment_metadata** | **String** | Metadata for the payment | [optional] |
+| **schedule** | [**PayoutSchedule**](PayoutSchedule.md) |  | [optional] |
 | **payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) |  | [optional] |
 ## Example
@@ -97,9 +99,11 @@ instance = VeloPayments::PaymentResponseV4.new(
   rejection_reason: null,
   withdrawn_reason: null,
   withdrawable: null,
+  auto_withdrawn_reason_code: null,
   transmission_type: null,
   payment_tracking_reference: null,
   payment_metadata: sample metadata,
+  schedule: null,
   payout: null
 )
 ```

data/docs/PaymentV3.md CHANGED Viewed

@@ -17,6 +17,7 @@
 | **transmission_type** | [**TransmissionType**](TransmissionType.md) |  | [optional] |
 | **remote_system_id** | **String** |  | [optional] |
 | **payment_metadata** | **String** |  | [optional] |
+| **auto_withdrawn_reason_code** | **String** | Populated only if the payment was automatically withdrawn during instruction for being invalid | [optional] |
 ## Example
@@ -36,7 +37,8 @@ instance = VeloPayments::PaymentV3.new(
   status: null,
   transmission_type: null,
   remote_system_id: Remote_System_Id_101234,
-  payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567
+  payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567,
+  auto_withdrawn_reason_code: VE0003
 )
 ```

data/docs/PayorCreateApiKeyRequest.md CHANGED Viewed

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **name** | **String** | A name for the key. |  |
 | **description** | **String** | Description of the key. | [optional] |
-| **roles** | **Array&lt;String&gt;** | A list of roles to assign to the key. |  |
+| **roles** | **Array&lt;String&gt;** | &lt;p&gt;A list of roles to assign to the key.&lt;/p&gt; &lt;p&gt;Only the first role name will be used&lt;/p&gt; &lt;p&gt;A later version will change this from a list to string&lt;/p&gt;  |  |
 ## Example