velopayments 2.26.124.beta1 → 2.35.58.beta1

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

@@ -1,16 +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 |
-| [**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 |
-| [**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
@@ -32,15 +34,15 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+api_instance = VeloPayments::PayoutsApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Create a quote for the payout
   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
 ```
 
@@ -58,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
 ```
 
@@ -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::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 PayoutsApi->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 PayoutsApi->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)
@@ -101,8 +171,8 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+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 
   remote_id: 'remote_id_example', # String | The remote id of the payees.
@@ -119,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
 ```
 
@@ -137,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
 ```
 
@@ -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] |
@@ -188,15 +258,15 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+api_instance = VeloPayments::PayoutsApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
 
 begin
   # Get Payout Summary
   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
 ```
 
@@ -214,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
 ```
 
@@ -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
 
@@ -257,14 +327,17 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+api_instance = VeloPayments::PayoutsApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
+opts = {
+  instruct_payout_request_v3: VeloPayments::InstructPayoutRequestV3.new # InstructPayoutRequestV3 | 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}"
+  puts "Error when calling PayoutsApi->instruct_payout_v3: #{e}"
 end
 ```
 
@@ -272,17 +345,17 @@ 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
 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
 ```
 
@@ -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_v3** | [**InstructPayoutRequestV3**](InstructPayoutRequestV3.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::PayoutsApi.new
+payout_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Id of the payout
+opts = {
+  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 PayoutsApi->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 PayoutsApi->schedule_for_payout_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payout_id** | **String** | Id of the payout |  |
+| **schedule_payout_request_v3** | [**SchedulePayoutRequestV3**](SchedulePayoutRequestV3.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
 
 
@@ -312,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
 
@@ -325,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
 ```
 
@@ -350,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
 ```
 
@@ -393,15 +539,15 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payment_id = TODO # String | Id of the Payment
+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
 
 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
 ```
 
@@ -419,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
 ```
 
@@ -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
 
@@ -463,14 +609,14 @@ VeloPayments.configure do |config|
   config.access_token = 'YOUR ACCESS TOKEN'
 end
 
-api_instance = VeloPayments::PayoutServiceApi.new
-payout_id = TODO # String | Id of the payout
+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
 ```
 
@@ -488,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
 ```
 
@@ -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/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/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
 )
 ```