velopayments 2.29.128.beta1 → 2.35.58.beta1

data/docs/{PayoutServiceApi.md → PayoutsApi.md}

@@ -1,18 +1,18 @@
-# VeloPayments::PayoutServiceApi
+# VeloPayments::PayoutsApi
 
 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 |
+| [**create_quote_for_payout_v3**](PayoutsApi.md#create_quote_for_payout_v3) | **POST** /v3/payouts/{payoutId}/quote | Create a quote for the payout |
+| [**deschedule_payout**](PayoutsApi.md#deschedule_payout) | **DELETE** /v3/payouts/{payoutId}/schedule | Deschedule a payout |
+| [**get_payments_for_payout_v3**](PayoutsApi.md#get_payments_for_payout_v3) | **GET** /v3/payouts/{payoutId}/payments | Retrieve payments for a payout |
+| [**get_payout_summary_v3**](PayoutsApi.md#get_payout_summary_v3) | **GET** /v3/payouts/{payoutId} | Get Payout Summary |
+| [**instruct_payout_v3**](PayoutsApi.md#instruct_payout_v3) | **POST** /v3/payouts/{payoutId} | Instruct Payout |
+| [**schedule_for_payout**](PayoutsApi.md#schedule_for_payout) | **POST** /v3/payouts/{payoutId}/schedule | Schedule a payout |
+| [**submit_payout_v3**](PayoutsApi.md#submit_payout_v3) | **POST** /v3/payouts | Submit Payout |
+| [**withdraw_payment**](PayoutsApi.md#withdraw_payment) | **POST** /v1/payments/{paymentId}/withdraw | Withdraw a Payment |
+| [**withdraw_payout_v3**](PayoutsApi.md#withdraw_payout_v3) | **DELETE** /v3/payouts/{payoutId} | Withdraw Payout |
 
 
 ## create_quote_for_payout_v3
@@ -34,7 +34,7 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
@@ -42,7 +42,7 @@ begin
   result = api_instance.create_quote_for_payout_v3(payout_id)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->create_quote_for_payout_v3: #{e}"
+  puts "Error when calling PayoutsApi->create_quote_for_payout_v3: #{e}"
 end
 ```
 
@@ -60,7 +60,7 @@ begin
   p headers # => { ... }
   p data # => <QuoteResponseV3>
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->create_quote_for_payout_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->create_quote_for_payout_v3_with_http_info: #{e}"
 end
 ```
 
@@ -103,14 +103,14 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.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}"
+  puts "Error when calling PayoutsApi->deschedule_payout: #{e}"
 end
 ```
 
@@ -128,7 +128,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->deschedule_payout_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->deschedule_payout_with_http_info: #{e}"
 end
 ```
 
@@ -171,7 +171,7 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 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 
@@ -189,7 +189,7 @@ begin
   result = api_instance.get_payments_for_payout_v3(payout_id, opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->get_payments_for_payout_v3: #{e}"
+  puts "Error when calling PayoutsApi->get_payments_for_payout_v3: #{e}"
 end
 ```
 
@@ -207,7 +207,7 @@ begin
   p headers # => { ... }
   p data # => <PagedPaymentsResponseV3>
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->get_payments_for_payout_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->get_payments_for_payout_v3_with_http_info: #{e}"
 end
 ```
 
@@ -258,7 +258,7 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
@@ -266,7 +266,7 @@ begin
   result = api_instance.get_payout_summary_v3(payout_id)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->get_payout_summary_v3: #{e}"
+  puts "Error when calling PayoutsApi->get_payout_summary_v3: #{e}"
 end
 ```
 
@@ -284,7 +284,7 @@ begin
   p headers # => { ... }
   p data # => <PayoutSummaryResponseV3>
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->get_payout_summary_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->get_payout_summary_v3_with_http_info: #{e}"
 end
 ```
 
@@ -327,17 +327,17 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 opts = {
-  instruct_payout_request: VeloPayments::InstructPayoutRequest.new # InstructPayoutRequest | Additional instruct payout parameters
+  instruct_payout_request_v3: VeloPayments::InstructPayoutRequestV3.new # InstructPayoutRequestV3 | Additional instruct payout parameters
 }
 
 begin
   # Instruct Payout
   api_instance.instruct_payout_v3(payout_id, opts)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->instruct_payout_v3: #{e}"
+  puts "Error when calling PayoutsApi->instruct_payout_v3: #{e}"
 end
 ```
 
@@ -355,7 +355,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->instruct_payout_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->instruct_payout_v3_with_http_info: #{e}"
 end
 ```
 
@@ -364,7 +364,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **payout_id** | **String** | Id of the payout |  |
-| **instruct_payout_request** | [**InstructPayoutRequest**](InstructPayoutRequest.md) | Additional instruct payout parameters | [optional] |
+| **instruct_payout_request_v3** | [**InstructPayoutRequestV3**](InstructPayoutRequestV3.md) | Additional instruct payout parameters | [optional] |
 
 ### Return type
 
@@ -399,17 +399,17 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.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
+  schedule_payout_request_v3: VeloPayments::SchedulePayoutRequestV3.new({scheduled_for: Time.parse('2025-01-01T10:00Z'), notifications_enabled: false}) # SchedulePayoutRequestV3 | 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}"
+  puts "Error when calling PayoutsApi->schedule_for_payout: #{e}"
 end
 ```
 
@@ -427,7 +427,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->schedule_for_payout_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->schedule_for_payout_with_http_info: #{e}"
 end
 ```
 
@@ -436,7 +436,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **payout_id** | **String** | Id of the payout |  |
-| **schedule_payout_request** | [**SchedulePayoutRequest**](SchedulePayoutRequest.md) | schedule payout parameters | [optional] |
+| **schedule_payout_request_v3** | [**SchedulePayoutRequestV3**](SchedulePayoutRequestV3.md) | schedule payout parameters | [optional] |
 
 ### Return type
 
@@ -458,7 +458,7 @@ nil (empty response body)
 
 Submit Payout
 
-<p>Create a new payout and return a location header with a link to get the payout.</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously.</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header.</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc.</p>  with no decimal places. 
+<p>Create a new payout and return a location header with a link to the payout</p> <p>Basic validation of the payout is performed before returning but more comprehensive validation is done asynchronously</p> <p>The results can be obtained by issuing a HTTP GET to the URL returned in the location header</p> <p>**NOTE:** amount values in payments must be in 'minor units' format. E.g. cents for USD, pence for GBP etc with no decimal places</p> 
 
 ### Examples
 
@@ -471,14 +471,14 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new({payments: [VeloPayments::PaymentInstructionV3.new({remote_id: 'remoteId1234', currency: 'USD', amount: 1299, source_account_name: 'MyAccountName'})]}) # CreatePayoutRequestV3 | Post amount to transfer using stored funding account details.
 
 begin
   # Submit Payout
   api_instance.submit_payout_v3(create_payout_request_v3)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->submit_payout_v3: #{e}"
+  puts "Error when calling PayoutsApi->submit_payout_v3: #{e}"
 end
 ```
 
@@ -496,7 +496,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->submit_payout_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->submit_payout_v3_with_http_info: #{e}"
 end
 ```
 
@@ -539,7 +539,7 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 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
 
@@ -547,7 +547,7 @@ begin
   # Withdraw a Payment
   api_instance.withdraw_payment(payment_id, withdraw_payment_request)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->withdraw_payment: #{e}"
+  puts "Error when calling PayoutsApi->withdraw_payment: #{e}"
 end
 ```
 
@@ -565,7 +565,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->withdraw_payment_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->withdraw_payment_with_http_info: #{e}"
 end
 ```
 
@@ -609,14 +609,14 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
+api_instance = VeloPayments::PayoutsApi.new
 payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Withdraw Payout
   api_instance.withdraw_payout_v3(payout_id)
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->withdraw_payout_v3: #{e}"
+  puts "Error when calling PayoutsApi->withdraw_payout_v3: #{e}"
 end
 ```
 
@@ -634,7 +634,7 @@ begin
   p headers # => { ... }
   p data # => nil
 rescue VeloPayments::ApiError => e
-  puts "Error when calling PayoutServiceApi->withdraw_payout_v3_with_http_info: #{e}"
+  puts "Error when calling PayoutsApi->withdraw_payout_v3_with_http_info: #{e}"
 end
 ```
 

data/docs/PostInstructFxInfo.md

@@ -0,0 +1,24 @@
+# VeloPayments::PostInstructFxInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **fx_mode** | **String** | The mode by which the FX rate is to be determined (MANUAL or AUTO) |  |
+| **fx_status** | **String** | The state to which the Post-Instruct FX process has reached (INITIATED or COMPLETED) |  |
+| **fx_status_updated_at** | **Time** | The date-time at which the most recent fxStatus was determined. |  |
+| **fx_transaction_reference** | **String** | The reference assigned to the FX funding that will fulfil this payment. | [optional] |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::PostInstructFxInfo.new(
+  fx_mode: MANUAL,
+  fx_status: INITIATED,
+  fx_status_updated_at: null,
+  fx_transaction_reference: AB123GHI
+)
+```
+

data/docs/{QueryBatchResponse.md → QueryBatchResponseV3.md}

@@ -1,20 +1,20 @@
-# VeloPayments::QueryBatchResponse
+# VeloPayments::QueryBatchResponseV3
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **status** | **String** | Batch Status | [optional] |
+| **status** | **String** | Batch Status. One of the following values: SUBMITTED, ACCEPTED | [optional] |
 | **failure_count** | **Integer** |  | [optional] |
 | **pending_count** | **Integer** |  | [optional] |
-| **failures** | [**Array<FailedSubmission>**](FailedSubmission.md) |  | [optional] |
+| **failures** | [**Array<FailedSubmissionV3>**](FailedSubmissionV3.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::QueryBatchResponse.new(
+instance = VeloPayments::QueryBatchResponseV3.new(
   status: null,
   failure_count: 2,
   pending_count: 2,

data/docs/{QueryBatchResponse2.md → QueryBatchResponseV4.md}

@@ -1,20 +1,20 @@
-# VeloPayments::QueryBatchResponse2
+# VeloPayments::QueryBatchResponseV4
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **status** | **String** | Batch Status | [optional] |
+| **status** | **String** | Batch Status. One of the following values: SUBMITTED, ACCEPTED | [optional] |
 | **failure_count** | **Integer** |  | [optional] |
 | **pending_count** | **Integer** |  | [optional] |
-| **failures** | [**Array<FailedSubmission2>**](FailedSubmission2.md) |  | [optional] |
+| **failures** | [**Array<FailedSubmissionV4>**](FailedSubmissionV4.md) |  | [optional] |
 
 ## Example
 
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::QueryBatchResponse2.new(
+instance = VeloPayments::QueryBatchResponseV4.new(
   status: null,
   failure_count: 2,
   pending_count: 2,

data/docs/QuoteFxSummaryV3.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **rate** | **Float** |  |  |
-| **inverted_rate** | **Float** |  | [optional] |
-| **creation_time** | **Time** |  |  |
-| **expiry_time** | **Time** |  | [optional] |
-| **quote_id** | **String** |  |  |
-| **total_source_amount** | **Integer** |  |  |
-| **total_payment_amount** | **Integer** |  |  |
+| **rate** | **Float** | The conversion rate (from the source currency to the payment currency) |  |
+| **inverted_rate** | **Float** | The inverse conversion rate (from paymnent currency to source currency) | [optional] |
+| **creation_time** | **Time** | Timestamp of when the quote was created |  |
+| **expiry_time** | **Time** | The timestamp for when the quote will expire | [optional] |
+| **quote_id** | **String** | The id of the created quote |  |
+| **total_source_amount** | **Integer** | The amount (in minor units) that will be paid from the source account |  |
+| **total_payment_amount** | **Integer** | The amount (in minor units) that the payee will receive |  |
 | **source_currency** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. |  |
 | **payment_currency** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. |  |
-| **funding_status** | **String** |  |  |
-| **status** | **String** |  |  |
+| **funding_status** | **String** | Current status of the funding associated with this quote. One of the following values: UNFUNDED, INSTRUCTED, FUNDED |  |
+| **status** | **String** | Current status of the fx quote. One of the following values: UNQUOTED, QUOTED, EXPIRED, EXECUTED, REJECTED |  |
 
 ## Example
 
@@ -22,13 +22,13 @@
 require 'velopayments'
 
 instance = VeloPayments::QuoteFxSummaryV3.new(
-  rate: 1.12,
+  rate: 0.89,
   inverted_rate: 1.12,
-  creation_time: null,
-  expiry_time: null,
-  quote_id: null,
-  total_source_amount: 1234,
-  total_payment_amount: 1234,
+  creation_time: 2022-10-30T09:45:09Z,
+  expiry_time: 2022-10-30T09:50:09Z,
+  quote_id: af80d455-29dd-4e72-a000-495a9829a7d0,
+  total_source_amount: 1000000,
+  total_payment_amount: 890000,
   source_currency: USD,
   payment_currency: USD,
   funding_status: FUNDED,

data/docs/RejectedPaymentV3.md

@@ -4,17 +4,17 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **remote_id** | **String** |  |  |
+| **remote_id** | **String** | The remoteId supplied by the payor that identifies the payee |  |
 | **currency_type** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. |  |
-| **amount** | **Integer** |  |  |
-| **source_account_name** | **String** |  |  |
-| **payor_payment_id** | **String** |  |  |
-| **remote_system_id** | **String** |  | [optional] |
-| **payment_metadata** | **String** |  | [optional] |
-| **reason** | **String** |  |  |
-| **reason_code** | **String** |  | [optional] |
-| **line_number** | **Integer** |  | [optional] |
-| **message** | **String** |  | [optional] |
+| **amount** | **Integer** | The amount of the payment in minor units |  |
+| **source_account_name** | **String** | The identifier of the source account to debit the payment from |  |
+| **payor_payment_id** | **String** | A reference identifier for the payor for the given payee payment |  |
+| **remote_system_id** | **String** | <p>The identifier for the remote payments system if not Velo</p>  | [optional] |
+| **payment_metadata** | **String** | <p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p> <p>The structure of the data will be dictated by the requirements of the payment rails</p>  | [optional] |
+| **reason** | **String** | The reason for the payment being rejected |  |
+| **reason_code** | **String** | The reason code as determined by Velo | [optional] |
+| **line_number** | **Integer** | If the payment was submitted in a csv payout then this will be the line number of the payment in the file | [optional] |
+| **message** | **String** | A more general rejection message than the reason property | [optional] |
 
 ## Example
 
@@ -24,14 +24,14 @@ require 'velopayments'
 instance = VeloPayments::RejectedPaymentV3.new(
   remote_id: remoteIdVal123,
   currency_type: USD,
-  amount: 1234,
-  source_account_name: Chase,
-  payor_payment_id: paymenIdVal123123,
-  remote_system_id: Remote_System_Id_101234,
+  amount: 10000,
+  source_account_name: Chase Bank Account,
+  payor_payment_id: 123211321ABSD,
+  remote_system_id: OB012,
   payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567,
   reason: The payee has not been onboarded,
-  reason_code: PAYMENT_VALUE_TOO_HIGH,
-  line_number: 10,
+  reason_code: VE1012,
+  line_number: 34,
   message: Payment cannot be processed because of the Payee's OFAC or Compliance Status
 )
 ```

data/docs/{SchedulePayoutRequest.md → SchedulePayoutRequestV3.md}

@@ -1,4 +1,4 @@
-# VeloPayments::SchedulePayoutRequest
+# VeloPayments::SchedulePayoutRequestV3
 
 ## Properties
 
@@ -12,7 +12,7 @@
 ```ruby
 require 'velopayments'
 
-instance = VeloPayments::SchedulePayoutRequest.new(
+instance = VeloPayments::SchedulePayoutRequestV3.new(
   scheduled_for: 2025-01-01T10:00Z,
   notifications_enabled: null
 )

data/docs/SetNotificationsRequest2.md

@@ -0,0 +1,18 @@
+# VeloPayments::SetNotificationsRequest2
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **minimum_balance** | **Integer** | Amount to set as minimum balance for notifications in minor units |  |
+
+## Example
+
+```ruby
+require 'velopayments'
+
+instance = VeloPayments::SetNotificationsRequest2.new(
+  minimum_balance: 10000000
+)
+```
+

data/docs/SourceAccountResponseV2.md

@@ -16,9 +16,9 @@
 | **balance_visible** | **Boolean** |  |  |
 | **customer_id** | **String** |  | [optional] |
 | **physical_account_id** | **String** |  | [optional] |
-| **notifications** | [**Notifications**](Notifications.md) |  | [optional] |
+| **notifications** | [**NotificationsV2**](NotificationsV2.md) |  | [optional] |
 | **funding_account_id** | **String** |  | [optional] |
-| **auto_top_up_config** | [**AutoTopUpConfig**](AutoTopUpConfig.md) |  | [optional] |
+| **auto_top_up_config** | [**AutoTopUpConfigV2**](AutoTopUpConfigV2.md) |  | [optional] |
 | **account_type** | **String** |  |  |
 
 ## Example

data/docs/SourceAccountResponseV3.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **id** | **String** | Source Account Id |  |
 | **balance** | **Integer** | Decimal implied | [optional] |
-| **currency** | **String** |  | [optional] |
+| **currency** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. | [optional] |
 | **funding_ref** | **String** | The funding reference (will not be set for DECOUPLED accounts). | [optional] |
 | **physical_account_name** | **String** | The physical account name (will not be set for DECOUPLED accounts). | [optional] |
 | **rails_id** | **String** |  |  |
@@ -15,10 +15,10 @@
 | **pooled** | **Boolean** | The pooled account flag (will not be set for DECOUPLED accounts). | [optional] |
 | **customer_id** | **String** |  | [optional] |
 | **physical_account_id** | **String** | The physical account id (will not be set for DECOUPLED accounts). | [optional] |
-| **notifications** | [**Notifications2**](Notifications2.md) |  | [optional] |
-| **auto_top_up_config** | [**AutoTopUpConfig2**](AutoTopUpConfig2.md) |  | [optional] |
+| **notifications** | [**NotificationsV3**](NotificationsV3.md) |  | [optional] |
+| **auto_top_up_config** | [**AutoTopUpConfigV3**](AutoTopUpConfigV3.md) |  | [optional] |
 | **type** | **String** |  |  |
-| **country** | **String** | The two character ISO country code for the associated account | [optional] |
+| **country** | **String** | Valid ISO 3166 2 character country code. See the <a href=\"https://www.iso.org/iso-3166-country-codes.html\" target=\"_blank\" a>ISO specification</a> for details. | [optional] |
 | **deleted** | **Boolean** | An optional flag for whether the source account has been deleted. Only present in the response if true. | [optional] |
 | **user_deleted** | **Boolean** | An optional flag for whether the source account has been deleted by a user. Only present in the response if true. | [optional] |
 | **deleted_at** | **Time** | An optional timestamp when the source account has been deleted. Only present in the response if deleted. | [optional] |

data/docs/SourceAccountSummary.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **source_account_id** | **String** |  |  |
 | **total_cost** | **Integer** |  |  |
-| **currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] |
+| **currency** | **String** | ISO-4217 3 character currency code | [optional] |
 
 ## Example
 
@@ -16,7 +16,7 @@ require 'velopayments'
 instance = VeloPayments::SourceAccountSummary.new(
   source_account_id: null,
   total_cost: 3344,
-  currency: null
+  currency: EUR
 )
 ```
 

data/docs/SourceAccountSummaryV3.md

@@ -6,7 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **source_account_id** | **String** |  |  |
 | **total_cost** | **Integer** |  |  |
-| **currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] |
+| **currency** | **String** | ISO 3 character currency code | [optional] |
 
 ## Example
 

data/docs/SourceAccountV3.md

@@ -4,10 +4,10 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **source_account_name** | **String** |  |  |
-| **source_account_id** | **String** |  |  |
+| **source_account_name** | **String** | The name of the source account as referencec in the payout |  |
+| **source_account_id** | **String** | The id of the payout |  |
 | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\" a>ISO specification</a> for details. |  |
-| **total_payout_cost** | **Integer** |  |  |
+| **total_payout_cost** | **Integer** | The total amount (in mnor units) that will be debited from the source account for the payout |  |
 
 ## Example
 
@@ -16,9 +16,9 @@ require 'velopayments'
 
 instance = VeloPayments::SourceAccountV3.new(
   source_account_name: AccountName,
-  source_account_id: null,
+  source_account_id: cf81e490-4ab8-49c2-bd68-9d1e725480cb,
   currency: USD,
-  total_payout_cost: 1231200
+  total_payout_cost: 1000000
 )
 ```