velopayments 2.26.124.beta1 → 2.29.128.beta1

data/docs/PayorLogoRequest.md

@@ -0,0 +1,18 @@
+# VeloPayments::PayorLogoRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logo** | **File** |  | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::PayorLogoRequest.new(
+  logo: null
+)
+```
+

data/docs/PayorV2.md

@@ -7,12 +7,14 @@
 | **payor_id** | **String** |  | [readonly] |
 | **payor_name** | **String** | The name of the payor. |  |
 | **payor_xid** | **String** | A unique identifier that an external system uses to reference the payor in their system | [optional] |
+| **provider** | **String** | The source of the payorXid, default is null which means Velo | [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** | [**KycState**](KycState.md) |  | [optional] |
 | **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] |
+| **open_banking_enabled** | **Boolean** | Is Open Banking supported for this payor | [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] |
@@ -37,12 +39,14 @@ instance = VeloPayments::PayorV2.new(
   payor_id: null,
   payor_name: Example, Corp,
   payor_xid: ABC_201234,
+  provider: null,
   address: null,
   primary_contact_name: Joe Buck,
   primary_contact_phone: 123-123-1234,
   primary_contact_email: joe.buck@example.com,
   kyc_state: null,
   manual_lockout: null,
+  open_banking_enabled: null,
   payee_grace_period_processing_enabled: null,
   payee_grace_period_days: null,
   collective_alias: Payee,

data/docs/PayorsApi.md

@@ -34,7 +34,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 
 begin
   # Get Payor
@@ -67,7 +67,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -103,7 +103,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 
 begin
   # Get Payor
@@ -136,7 +136,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -172,7 +172,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 opts = {
   logo: File.new('/path/to/some/file') # File | 
 }
@@ -207,7 +207,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 | **logo** | **File** |  | [optional] |
 
 ### Return type
@@ -244,9 +244,9 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
-application_id = TODO # String | Application ID
-payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ['payor.admin']}) # PayorCreateApiKeyRequest | Details of application API key to create
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+application_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Application ID
+payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ["payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
 
 begin
   # Create API Key
@@ -279,8 +279,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
-| **application_id** | [**String**](.md) | Application ID |  |
+| **payor_id** | **String** | The Payor Id |  |
+| **application_id** | **String** | Application ID |  |
 | **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md) | Details of application API key to create |  |
 
 ### Return type
@@ -317,7 +317,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new({name: 'SAP'}) # PayorCreateApplicationRequest | Details of application to create
 
 begin
@@ -350,7 +350,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 | **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md) | Details of application to create |  |
 
 ### Return type
@@ -387,7 +387,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new({reminder_emails_opt_out: false}) # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
 
 begin
@@ -420,7 +420,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 | **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md) | Reminder Emails Opt-Out Request |  |
 
 ### Return type
@@ -457,7 +457,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = TODO # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
 
 begin
   # Get Branding
@@ -490,7 +490,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -527,8 +527,8 @@ end
 
 api_instance = VeloPayments::PayorsApi.new
 opts = {
-  descendants_of_payor: TODO, # String | The Payor ID from which to start the query to show all descendants
-  parent_of_payor: TODO, # String | Look for the parent payor details for this payor id
+  descendants_of_payor: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The Payor ID from which to start the query to show all descendants
+  parent_of_payor: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # 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 
 }
 
@@ -563,8 +563,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **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] |
+| **descendants_of_payor** | **String** | The Payor ID from which to start the query to show all descendants | [optional] |
+| **parent_of_payor** | **String** | 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/PayoutSchedule.md

@@ -0,0 +1,28 @@
+# VeloPayments::PayoutSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schedule_status** | [**ScheduleStatus**](ScheduleStatus.md) |  |  |
+| **scheduled_at** | **Time** |  |  |
+| **scheduled_for** | **Time** |  |  |
+| **scheduled_by_principal_id** | **String** | ID of the user or application that scheduled the payout |  |
+| **notifications_enabled** | **Boolean** |  |  |
+| **scheduled_by** | **String** | Optional display name as a hint for who scheduled the payout. Not populated if payout was scheduled by an application. | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::PayoutSchedule.new(
+  schedule_status: null,
+  scheduled_at: null,
+  scheduled_for: null,
+  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
+  notifications_enabled: null,
+  scheduled_by: Aphra Behn
+)
+```
+

data/docs/PayoutSchedule2.md

@@ -0,0 +1,26 @@
+# VeloPayments::PayoutSchedule2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schedule_status** | [**ScheduleStatus2**](ScheduleStatus2.md) |  |  |
+| **scheduled_at** | **Time** |  |  |
+| **scheduled_for** | **Time** |  |  |
+| **scheduled_by_principal_id** | **String** | ID of the user or application that scheduled the payout |  |
+| **notifications_enabled** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::PayoutSchedule2.new(
+  schedule_status: null,
+  scheduled_at: null,
+  scheduled_for: null,
+  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
+  notifications_enabled: null
+)
+```
+

data/docs/PayoutServiceApi.md

@@ -5,9 +5,11 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
 | [**create_quote_for_payout_v3**](PayoutServiceApi.md#create_quote_for_payout_v3) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout |
+| [**deschedule_payout**](PayoutServiceApi.md#deschedule_payout) | **DELETE** /v3/payouts/{payoutId}/schedule | Deschedule a payout |
 | [**get_payments_for_payout_v3**](PayoutServiceApi.md#get_payments_for_payout_v3) | **GET** /v3/payouts/{payoutId}/payments | Retrieve payments for a payout |
 | [**get_payout_summary_v3**](PayoutServiceApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary |
 | [**instruct_payout_v3**](PayoutServiceApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout |
+| [**schedule_for_payout**](PayoutServiceApi.md#schedule_for_payout) | **POST** /v3/payouts/{payoutId}/schedule | Schedule a payout |
 | [**submit_payout_v3**](PayoutServiceApi.md#submit_payout_v3) | **POST** /v3/payouts | Submit Payout |
 | [**withdraw_payment**](PayoutServiceApi.md#withdraw_payment) | **POST** /v1/payments/{paymentId}/withdraw | Withdraw a Payment |
 | [**withdraw_payout_v3**](PayoutServiceApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout |
@@ -33,7 +35,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Create a quote for the payout
@@ -66,7 +68,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | Id of the payout |  |
+| **payout_id** | **String** | Id of the payout |  |
 
 ### Return type
 
@@ -82,6 +84,74 @@ end
 - **Accept**: application/json
 
 
+## deschedule_payout
+
+> deschedule_payout(payout_id)
+
+Deschedule a payout
+
+Remove the schedule for a scheduled payout
+
+### Examples
+
+```ruby
+require 'time'
+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::PayoutServiceApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
+
+begin
+  # Deschedule a payout
+  api_instance.deschedule_payout(payout_id)
+rescue VeloPayments::ApiError => e
+  puts "Error when calling PayoutServiceApi->deschedule_payout: #{e}"
+end
+```
+
+#### Using the deschedule_payout_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> deschedule_payout_with_http_info(payout_id)
+
+```ruby
+begin
+  # Deschedule a payout
+  data, status_code, headers = api_instance.deschedule_payout_with_http_info(payout_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VeloPayments::ApiError => e
+  puts "Error when calling PayoutServiceApi->deschedule_payout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payout_id** | **String** | Id of the payout |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_payments_for_payout_v3
 
 > <PagedPaymentsResponseV3> get_payments_for_payout_v3(payout_id, opts)
@@ -102,7 +172,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 opts = {
   status: 'ACCEPTED', # String | Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal 
   remote_id: 'remote_id_example', # String | The remote id of the payees.
@@ -145,7 +215,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | Id of the payout |  |
+| **payout_id** | **String** | Id of the payout |  |
 | **status** | **String** | Payment Status * ACCEPTED: any payment which was accepted at submission time (status may have changed since) * REJECTED: any payment rejected by initial submission processing * WITHDRAWN: any payment which has been withdrawn * WITHDRAWABLE: any payment eligible for withdrawal  | [optional] |
 | **remote_id** | **String** | The remote id of the payees. | [optional] |
 | **payor_payment_id** | **String** | Payor&#39;s Id of the Payment | [optional] |
@@ -189,7 +259,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Get Payout Summary
@@ -222,7 +292,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | Id of the payout |  |
+| **payout_id** | **String** | Id of the payout |  |
 
 ### Return type
 
@@ -240,7 +310,7 @@ end
 
 ## instruct_payout_v3
 
-> instruct_payout_v3(payout_id)
+> instruct_payout_v3(payout_id, opts)
 
 Instruct Payout
 
@@ -258,11 +328,14 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
+opts = {
+  instruct_payout_request: VeloPayments::InstructPayoutRequest.new # InstructPayoutRequest | Additional instruct payout parameters
+}
 
 begin
   # Instruct Payout
-  api_instance.instruct_payout_v3(payout_id)
+  api_instance.instruct_payout_v3(payout_id, opts)
 rescue VeloPayments::ApiError => e
   puts "Error when calling PayoutServiceApi->instruct_payout_v3: #{e}"
 end
@@ -272,12 +345,12 @@ end
 
 This returns an Array which contains the response data (`nil` in this case), status code and headers.
 
-> <Array(nil, Integer, Hash)> instruct_payout_v3_with_http_info(payout_id)
+> <Array(nil, Integer, Hash)> instruct_payout_v3_with_http_info(payout_id, opts)
 
 ```ruby
 begin
   # Instruct Payout
-  data, status_code, headers = api_instance.instruct_payout_v3_with_http_info(payout_id)
+  data, status_code, headers = api_instance.instruct_payout_v3_with_http_info(payout_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
@@ -290,7 +363,8 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | Id of the payout |  |
+| **payout_id** | **String** | Id of the payout |  |
+| **instruct_payout_request** | [**InstructPayoutRequest**](InstructPayoutRequest.md) | Additional instruct payout parameters | [optional] |
 
 ### Return type
 
@@ -302,7 +376,79 @@ nil (empty response body)
 
 ### HTTP request headers
 
-- **Content-Type**: Not defined
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## schedule_for_payout
+
+> schedule_for_payout(payout_id, opts)
+
+Schedule a payout
+
+<p>Schedule a payout for auto-instruction in the future or update existing payout schedule if the payout has been scheduled before.</p> 
+
+### Examples
+
+```ruby
+require 'time'
+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::PayoutServiceApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
+opts = {
+  schedule_payout_request: VeloPayments::SchedulePayoutRequest.new({scheduled_for: Time.parse('2025-01-01T10:00Z'), notifications_enabled: false}) # SchedulePayoutRequest | schedule payout parameters
+}
+
+begin
+  # Schedule a payout
+  api_instance.schedule_for_payout(payout_id, opts)
+rescue VeloPayments::ApiError => e
+  puts "Error when calling PayoutServiceApi->schedule_for_payout: #{e}"
+end
+```
+
+#### Using the schedule_for_payout_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> schedule_for_payout_with_http_info(payout_id, opts)
+
+```ruby
+begin
+  # Schedule a payout
+  data, status_code, headers = api_instance.schedule_for_payout_with_http_info(payout_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue VeloPayments::ApiError => e
+  puts "Error when calling PayoutServiceApi->schedule_for_payout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payout_id** | **String** | Id of the payout |  |
+| **schedule_payout_request** | [**SchedulePayoutRequest**](SchedulePayoutRequest.md) | schedule payout parameters | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
 - **Accept**: application/json
 
 
@@ -394,7 +540,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payment_id = TODO # String | Id of the Payment
+payment_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the Payment
 withdraw_payment_request = VeloPayments::WithdrawPaymentRequest.new({reason: 'Payment submitted in error'}) # WithdrawPaymentRequest | details for withdrawal
 
 begin
@@ -427,7 +573,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payment_id** | [**String**](.md) | Id of the Payment |  |
+| **payment_id** | **String** | Id of the Payment |  |
 | **withdraw_payment_request** | [**WithdrawPaymentRequest**](WithdrawPaymentRequest.md) | details for withdrawal |  |
 
 ### Return type
@@ -450,7 +596,7 @@ nil (empty response body)
 
 Withdraw Payout
 
-Withdraw Payout will delete payout details from payout service and rails services but will just move the status of the payout to WITHDRAWN in payment audit.
+Withdraw Payout will remove the payout details from the rails but the payout will still be accessible in payout service in WITHDRAWN status.
 
 ### Examples
 
@@ -464,7 +610,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Withdraw Payout
@@ -496,7 +642,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | [**String**](.md) | Id of the payout |  |
+| **payout_id** | **String** | Id of the payout |  |
 
 ### Return type
 

data/docs/PayoutSummaryAudit.md

@@ -20,6 +20,7 @@
 | **payout_memo** | **String** |  | [optional] |
 | **payout_type** | [**PayoutType**](PayoutType.md) |  |  |
 | **payor_name** | **String** |  |  |
+| **schedule** | [**PayoutSchedule**](PayoutSchedule.md) |  | [optional] |
 
 ## Example
 
@@ -42,7 +43,8 @@ instance = VeloPayments::PayoutSummaryAudit.new(
   fx_summaries: null,
   payout_memo: null,
   payout_type: null,
-  payor_name: null
+  payor_name: null,
+  schedule: null
 )
 ```
 

data/docs/PayoutSummaryResponseV3.md

@@ -14,6 +14,7 @@
 | **accounts** | [**Array<SourceAccountV3>**](SourceAccountV3.md) |  |  |
 | **accepted_payments** | [**Array<AcceptedPaymentV3>**](AcceptedPaymentV3.md) |  |  |
 | **rejected_payments** | [**Array<RejectedPaymentV3>**](RejectedPaymentV3.md) |  |  |
+| **schedule** | [**PayoutSchedule2**](PayoutSchedule2.md) |  | [optional] |
 
 ## Example
 
@@ -30,7 +31,8 @@ instance = VeloPayments::PayoutSummaryResponseV3.new(
   fx_summaries: null,
   accounts: null,
   accepted_payments: null,
-  rejected_payments: null
+  rejected_payments: null,
+  schedule: null
 )
 ```
 

data/docs/PingResponse.md

@@ -0,0 +1,20 @@
+# VeloPayments::PingResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **webhook_id** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::PingResponse.new(
+  id: null,
+  webhook_id: null
+)
+```
+

data/docs/SchedulePayoutRequest.md

@@ -0,0 +1,20 @@
+# VeloPayments::SchedulePayoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **scheduled_for** | **Time** | UTC timestamp for instructing the payout. Format is ISO-8601. |  |
+| **notifications_enabled** | **Boolean** | Flag to indicate whether to receive notifications when scheduled payout is processed |  |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::SchedulePayoutRequest.new(
+  scheduled_for: 2025-01-01T10:00Z,
+  notifications_enabled: null
+)
+```
+

data/docs/ScheduleStatus.md

@@ -0,0 +1,15 @@
+# VeloPayments::ScheduleStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::ScheduleStatus.new()
+```
+

data/docs/ScheduleStatus2.md

@@ -0,0 +1,15 @@
+# VeloPayments::ScheduleStatus2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::ScheduleStatus2.new()
+```
+