velopayments 2.26.124.beta1 → 2.35.58.beta1

data/docs/PayorsApi.md

@@ -4,23 +4,22 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_payor_by_id**](PayorsApi.md#get_payor_by_id) | **GET** /v1/payors/{payorId} | Get Payor |
+| [**get_payor_by_id_v1**](PayorsApi.md#get_payor_by_id_v1) | **GET** /v1/payors/{payorId} | Get Payor |
 | [**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor |
-| [**payor_add_payor_logo**](PayorsApi.md#payor_add_payor_logo) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
-| [**payor_create_api_key_request**](PayorsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
-| [**payor_create_application_request**](PayorsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application |
+| [**payor_add_payor_logo_v1**](PayorsApi.md#payor_add_payor_logo_v1) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
+| [**payor_create_api_key_v1**](PayorsApi.md#payor_create_api_key_v1) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
+| [**payor_create_application_v1**](PayorsApi.md#payor_create_application_v1) | **POST** /v1/payors/{payorId}/applications | Create Application |
 | [**payor_email_opt_out**](PayorsApi.md#payor_email_opt_out) | **POST** /v1/payors/{payorId}/reminderEmailsUpdate | Reminder Email Opt-Out |
 | [**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding |
-| [**payor_links**](PayorsApi.md#payor_links) | **GET** /v1/payorLinks | List Payor Links |
 
 
-## get_payor_by_id
+## get_payor_by_id_v1
 
-> <PayorV1> get_payor_by_id(payor_id)
+> <PayorV1> get_payor_by_id_v1(payor_id)
 
 Get Payor
 
-Get a Single Payor by Id. 
+<p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors 
 
 ### Examples
 
@@ -34,32 +33,32 @@ 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
-  result = api_instance.get_payor_by_id(payor_id)
+  result = api_instance.get_payor_by_id_v1(payor_id)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->get_payor_by_id: #{e}"
+  puts "Error when calling PayorsApi->get_payor_by_id_v1: #{e}"
 end
 ```
 
-#### Using the get_payor_by_id_with_http_info variant
+#### Using the get_payor_by_id_v1_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_with_http_info(payor_id)
+> <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_v1_with_http_info(payor_id)
 
 ```ruby
 begin
   # Get Payor
-  data, status_code, headers = api_instance.get_payor_by_id_with_http_info(payor_id)
+  data, status_code, headers = api_instance.get_payor_by_id_v1_with_http_info(payor_id)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <PayorV1>
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->get_payor_by_id_with_http_info: #{e}"
+  puts "Error when calling PayorsApi->get_payor_by_id_v1_with_http_info: #{e}"
 end
 ```
 
@@ -67,7 +66,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -103,7 +102,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 +135,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -152,13 +151,13 @@ end
 - **Accept**: application/json
 
 
-## payor_add_payor_logo
+## payor_add_payor_logo_v1
 
-> payor_add_payor_logo(payor_id, opts)
+> payor_add_payor_logo_v1(payor_id, opts)
 
 Add Logo
 
-Add Payor Logo. Logo file is used in your branding, and emails sent to payees.
+<p>Add Payor Logo</p> <p>Logo file is used in your branding and emails sent to payees</p> 
 
 ### Examples
 
@@ -172,34 +171,34 @@ 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 | 
 }
 
 begin
   # Add Logo
-  api_instance.payor_add_payor_logo(payor_id, opts)
+  api_instance.payor_add_payor_logo_v1(payor_id, opts)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_add_payor_logo: #{e}"
+  puts "Error when calling PayorsApi->payor_add_payor_logo_v1: #{e}"
 end
 ```
 
-#### Using the payor_add_payor_logo_with_http_info variant
+#### Using the payor_add_payor_logo_v1_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)> payor_add_payor_logo_with_http_info(payor_id, opts)
+> <Array(nil, Integer, Hash)> payor_add_payor_logo_v1_with_http_info(payor_id, opts)
 
 ```ruby
 begin
   # Add Logo
-  data, status_code, headers = api_instance.payor_add_payor_logo_with_http_info(payor_id, opts)
+  data, status_code, headers = api_instance.payor_add_payor_logo_v1_with_http_info(payor_id, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_add_payor_logo_with_http_info: #{e}"
+  puts "Error when calling PayorsApi->payor_add_payor_logo_v1_with_http_info: #{e}"
 end
 ```
 
@@ -207,7 +206,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 | **logo** | **File** |  | [optional] |
 
 ### Return type
@@ -224,13 +223,13 @@ nil (empty response body)
 - **Accept**: application/json
 
 
-## payor_create_api_key_request
+## payor_create_api_key_v1
 
-> <PayorCreateApiKeyResponse> payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+> <PayorCreateApiKeyResponse> payor_create_api_key_v1(payor_id, application_id, payor_create_api_key_request)
 
 Create API Key
 
-Create an an API key for the given payor Id and application Id
+<p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p> 
 
 ### Examples
 
@@ -244,34 +243,34 @@ 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: ["velo.payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
 
 begin
   # Create API Key
-  result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+  result = api_instance.payor_create_api_key_v1(payor_id, application_id, payor_create_api_key_request)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_create_api_key_request: #{e}"
+  puts "Error when calling PayorsApi->payor_create_api_key_v1: #{e}"
 end
 ```
 
-#### Using the payor_create_api_key_request_with_http_info variant
+#### Using the payor_create_api_key_v1_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<PayorCreateApiKeyResponse>, Integer, Hash)> payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
+> <Array(<PayorCreateApiKeyResponse>, Integer, Hash)> payor_create_api_key_v1_with_http_info(payor_id, application_id, payor_create_api_key_request)
 
 ```ruby
 begin
   # Create API Key
-  data, status_code, headers = api_instance.payor_create_api_key_request_with_http_info(payor_id, application_id, payor_create_api_key_request)
+  data, status_code, headers = api_instance.payor_create_api_key_v1_with_http_info(payor_id, application_id, payor_create_api_key_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <PayorCreateApiKeyResponse>
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_create_api_key_request_with_http_info: #{e}"
+  puts "Error when calling PayorsApi->payor_create_api_key_v1_with_http_info: #{e}"
 end
 ```
 
@@ -279,8 +278,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
@@ -297,13 +296,13 @@ end
 - **Accept**: application/json
 
 
-## payor_create_application_request
+## payor_create_application_v1
 
-> payor_create_application_request(payor_id, payor_create_application_request)
+> payor_create_application_v1(payor_id, payor_create_application_request)
 
 Create Application
 
-Create an application for the given Payor ID. Applications are programatic users which can be assigned unique keys.
+<p>Create an application for the given Payor ID.</p> <p>Applications provide a means to group your API Keys</p> <p>For example you might have an SAP application that you wish to integrate with Velo</p> <p>You can create an application and then create one or more API keys for the application</p> 
 
 ### Examples
 
@@ -317,32 +316,32 @@ 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
   # Create Application
-  api_instance.payor_create_application_request(payor_id, payor_create_application_request)
+  api_instance.payor_create_application_v1(payor_id, payor_create_application_request)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_create_application_request: #{e}"
+  puts "Error when calling PayorsApi->payor_create_application_v1: #{e}"
 end
 ```
 
-#### Using the payor_create_application_request_with_http_info variant
+#### Using the payor_create_application_v1_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)> payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
+> <Array(nil, Integer, Hash)> payor_create_application_v1_with_http_info(payor_id, payor_create_application_request)
 
 ```ruby
 begin
   # Create Application
-  data, status_code, headers = api_instance.payor_create_application_request_with_http_info(payor_id, payor_create_application_request)
+  data, status_code, headers = api_instance.payor_create_application_v1_with_http_info(payor_id, payor_create_application_request)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_create_application_request_with_http_info: #{e}"
+  puts "Error when calling PayorsApi->payor_create_application_v1_with_http_info: #{e}"
 end
 ```
 
@@ -350,7 +349,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 +386,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 +419,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 +456,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 +489,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | [**String**](.md) | The Payor Id |  |
+| **payor_id** | **String** | The Payor Id |  |
 
 ### Return type
 
@@ -505,78 +504,3 @@ end
 - **Content-Type**: Not defined
 - **Accept**: application/json
 
-
-## payor_links
-
-> <PayorLinksResponse> payor_links(opts)
-
-List Payor Links
-
-This endpoint allows you to list payor links
-
-### 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::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
-  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(opts)
-  p result
-rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_links: #{e}"
-end
-```
-
-#### Using the payor_links_with_http_info variant
-
-This returns an Array which contains the response data, status code and headers.
-
-> <Array(<PayorLinksResponse>, Integer, Hash)> payor_links_with_http_info(opts)
-
-```ruby
-begin
-  # List Payor Links
-  data, status_code, headers = api_instance.payor_links_with_http_info(opts)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <PayorLinksResponse>
-rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->payor_links_with_http_info: #{e}"
-end
-```
-
-### Parameters
-
-| 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] |
-| **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 - &#39;fields&#39; allows you to add to this. Example: &#x60;&#x60;&#x60;fields&#x3D;primaryContactEmail,kycState&#x60;&#x60;&#x60; - 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
-
-[**PayorLinksResponse**](PayorLinksResponse.md)
-
-### Authorization
-
-[OAuth2](../README.md#OAuth2)
-
-### HTTP request headers
-
-- **Content-Type**: Not defined
-- **Accept**: application/json
-

data/docs/PayoutSchedule.md

@@ -0,0 +1,28 @@
+# VeloPayments::PayoutSchedule
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schedule_status** | **String** | Current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED |  |
+| **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: SCHEDULED,
+  scheduled_at: null,
+  scheduled_for: null,
+  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
+  notifications_enabled: null,
+  scheduled_by: Aphra Behn
+)
+```
+

data/docs/PayoutScheduleV3.md

@@ -0,0 +1,26 @@
+# VeloPayments::PayoutScheduleV3
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **schedule_status** | **String** | The current status of the payout schedule. One of the following values: SCHEDULED, EXECUTED, FAILED |  |
+| **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::PayoutScheduleV3.new(
+  schedule_status: SCHEDULED,
+  scheduled_at: null,
+  scheduled_for: null,
+  scheduled_by_principal_id: 8946953b-1e3b-49cf-9da4-b704cbb78f3e,
+  notifications_enabled: null
+)
+```
+

data/docs/PayoutSummaryAudit.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **payout_id** | **String** |  | [optional] |
 | **payor_id** | **String** |  | [optional] |
-| **status** | [**PayoutStatus**](PayoutStatus.md) |  |  |
+| **status** | **String** | Current status of the Payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN |  |
 | **date_time** | **Time** |  | [optional] |
 | **submitted_date_time** | **String** |  |  |
 | **instructed_date_time** | **String** |  | [optional] |
@@ -18,8 +18,9 @@
 | **source_account_summary** | [**Array<SourceAccountSummary>**](SourceAccountSummary.md) |  | [optional] |
 | **fx_summaries** | [**Array<FxSummary>**](FxSummary.md) |  | [optional] |
 | **payout_memo** | **String** |  | [optional] |
-| **payout_type** | [**PayoutType**](PayoutType.md) |  |  |
+| **payout_type** | **String** | The type of payout. One of the following values: STANDARD, AS, ON_BEHALF_OF |  |
 | **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/PayoutSummaryAuditV3.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **payout_id** | **String** |  |  |
 | **payor_id** | **String** |  | [optional] |
-| **status** | [**PayoutStatusV3**](PayoutStatusV3.md) |  |  |
+| **status** | **String** | Current status of the payout. One of the following values: ACCEPTED, REJECTED, SUBMITTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, CONFIRMED, WITHDRAWN |  |
 | **submitted_date_time** | **String** |  |  |
 | **instructed_date_time** | **String** |  | [optional] |
 | **withdrawn_date_time** | **String** |  | [optional] |

data/docs/PayoutSummaryResponseV3.md

@@ -4,16 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payout_id** | **String** |  | [optional] |
-| **status** | **String** |  | [optional] |
-| **payments_submitted** | **Integer** |  | [optional] |
-| **payments_accepted** | **Integer** |  | [optional] |
-| **payments_rejected** | **Integer** |  | [optional] |
-| **payments_withdrawn** | **Integer** |  |  |
+| **payout_id** | **String** | The id of the payout | [optional] |
+| **status** | **String** | The status of the payout (one of SUBMITTED, ACCEPTED, REJECTED, QUOTED, INSTRUCTED, COMPLETED, INCOMPLETE, WITHDRAWN) | [optional] |
+| **payments_submitted** | **Integer** | The number of payments that were submitted in the payout | [optional] |
+| **payments_accepted** | **Integer** | The number of payments that were accepted in the payout | [optional] |
+| **payments_rejected** | **Integer** | The number of payments that were rejected in the payout | [optional] |
+| **payments_withdrawn** | **Integer** | The number of payments that were withdrawn in the payout |  |
 | **fx_summaries** | [**Array<QuoteFxSummaryV3>**](QuoteFxSummaryV3.md) |  |  |
 | **accounts** | [**Array<SourceAccountV3>**](SourceAccountV3.md) |  |  |
 | **accepted_payments** | [**Array<AcceptedPaymentV3>**](AcceptedPaymentV3.md) |  |  |
 | **rejected_payments** | [**Array<RejectedPaymentV3>**](RejectedPaymentV3.md) |  |  |
+| **schedule** | [**PayoutScheduleV3**](PayoutScheduleV3.md) |  | [optional] |
 
 ## Example
 
@@ -21,16 +22,17 @@
 require 'velopayments'
 
 instance = VeloPayments::PayoutSummaryResponseV3.new(
-  payout_id: null,
+  payout_id: cf81e490-4ab8-49c2-bd68-9d1e725480cb,
   status: COMPLETED,
   payments_submitted: 10,
-  payments_accepted: 10,
-  payments_rejected: 0,
+  payments_accepted: 9,
+  payments_rejected: 1,
   payments_withdrawn: 0,
   fx_summaries: null,
   accounts: null,
   accepted_payments: null,
-  rejected_payments: null
+  rejected_payments: null,
+  schedule: null
 )
 ```