velopayments 2.20.119 → 2.23.78.beta1

data/docs/PaymentDeltaResponseV4.md

@@ -0,0 +1,21 @@
+# VeloPayments::PaymentDeltaResponseV4
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | [**PagedPayeeInvitationStatusResponsePage**](PagedPayeeInvitationStatusResponsePage.md) |  | [optional] 
+**links** | [**Array<PagedPayeeResponseLinks>**](PagedPayeeResponseLinks.md) |  | [optional] 
+**content** | [**Array<PaymentDeltaV4>**](PaymentDeltaV4.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentDeltaResponseV4.new(page: null,
+                                 links: null,
+                                 content: null)
+```
+
+

data/docs/PaymentDeltaV4.md

@@ -0,0 +1,31 @@
+# VeloPayments::PaymentDeltaV4
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** |  | [readonly] 
+**payout_id** | **String** |  | [readonly] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_currency** | **String** |  | [optional] 
+**payment_amount** | **Integer** |  | [optional] 
+**status** | **String** |  | [optional] 
+**source_currency** | **String** |  | [optional] 
+**source_amount** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentDeltaV4.new(payment_id: null,
+                                 payout_id: null,
+                                 payor_payment_id: null,
+                                 payment_currency: null,
+                                 payment_amount: null,
+                                 status: null,
+                                 source_currency: null,
+                                 source_amount: null)
+```
+
+

data/docs/PaymentEventResponseV3.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_id** | **String** | The id of the event. | 
-**event_date_time** | **DateTime** | The date/time at which the event occurred. | 
+**event_date_time** | **Time** | The date/time at which the event occurred. | 
 **event_type** | **String** | The type of the event. | 
 **source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
 **source_amount** | **Integer** | The source amount exposed by the event. | [optional] 

data/docs/PaymentEventResponseV4.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **event_id** | **String** | The id of the event. | 
-**event_date_time** | **DateTime** | The date/time at which the event occurred. | 
+**event_date_time** | **Time** | The date/time at which the event occurred. | 
 **event_type** | **String** | The type of the event. | 
 **source_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
 **source_amount** | **Integer** | The source amount exposed by the event. | [optional] 

data/docs/{PaymentInstruction.md → PaymentInstructionV3.md}

@@ -1,4 +1,4 @@
-# VeloPayments::PaymentInstruction
+# VeloPayments::PaymentInstructionV3
 
 ## Properties
 
@@ -10,18 +10,20 @@ Name | Type | Description | Notes
 **payment_memo** | **String** |  | [optional] 
 **source_account_name** | **String** |  | 
 **payor_payment_id** | **String** |  | [optional] 
+**transmission_type** | [**TransmissionType**](TransmissionType.md) |  | [optional] 
 
 ## Code Sample
 
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentInstruction.new(remote_id: remoteId1234,
+instance = VeloPayments::PaymentInstructionV3.new(remote_id: remoteId1234,
                                  currency: USD,
                                  amount: 1299,
                                  payment_memo: my memo,
                                  source_account_name: MyAccountName,
-                                 payor_payment_id: 123211321ABSD)
+                                 payor_payment_id: 123211321ABSD,
+                                 transmission_type: null)
 ```
 
 

data/docs/PaymentResponseV3.md

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
 **payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
 **rate** | **Float** | The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] 
 **inverted_rate** | **Float** | The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] 
-**submitted_date_time** | **DateTime** |  | 
+**submitted_date_time** | **Time** |  | 
 **status** | **String** |  | 
 **funding_status** | **String** | The funding status of the payment | 
 **routing_number** | **String** | The routing number for the payment. | [optional] 

data/docs/PaymentResponseV4.md

@@ -18,7 +18,8 @@ Name | Type | Description | Notes
 **payment_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
 **rate** | **Float** | The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] 
 **inverted_rate** | **Float** | The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional] 
-**submitted_date_time** | **DateTime** |  | 
+**is_payment_ccy_base_ccy** | **Boolean** |  | [optional] 
+**submitted_date_time** | **Time** |  | 
 **status** | **String** |  | 
 **funding_status** | **String** | The funding status of the payment | 
 **routing_number** | **String** | The routing number for the payment. | [optional] 
@@ -40,6 +41,8 @@ Name | Type | Description | Notes
 **rails_payment_id** | **String** |  | [optional] 
 **rails_batch_id** | **String** |  | [optional] 
 **rejection_reason** | **String** |  | [optional] 
+**withdrawn_reason** | **String** |  | [optional] 
+**withdrawable** | **Boolean** |  | [optional] 
 **payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) |  | [optional] 
 
 ## Code Sample
@@ -61,6 +64,7 @@ instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  payment_currency: null,
                                  rate: null,
                                  inverted_rate: null,
+                                 is_payment_ccy_base_ccy: null,
                                  submitted_date_time: null,
                                  status: null,
                                  funding_status: null,
@@ -83,6 +87,8 @@ instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  rails_payment_id: null,
                                  rails_batch_id: null,
                                  rejection_reason: null,
+                                 withdrawn_reason: null,
+                                 withdrawable: null,
                                  payout: null)
 ```
 

data/docs/PaymentV3.md

@@ -0,0 +1,37 @@
+# VeloPayments::PaymentV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_id** | **String** |  | 
+**remote_id** | **String** |  | [optional] 
+**currency** | **String** |  | [optional] 
+**amount** | **Integer** |  | [optional] 
+**source_account_name** | **String** |  | [optional] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_memo** | **String** |  | [optional] 
+**payee** | [**PayoutPayeeV3**](PayoutPayeeV3.md) |  | [optional] 
+**withdrawable** | **Boolean** |  | [optional] 
+**status** | **String** |  | [optional] 
+**transmission_type** | [**TransmissionType**](TransmissionType.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentV3.new(payment_id: null,
+                                 remote_id: remoteIdVal123,
+                                 currency: USD,
+                                 amount: 1234,
+                                 source_account_name: Chase,
+                                 payor_payment_id: paymenIdVal123123,
+                                 payment_memo: Payment memo,
+                                 payee: null,
+                                 withdrawable: false,
+                                 status: null,
+                                 transmission_type: null)
+```
+
+

data/docs/PayorV1.md

@@ -25,6 +25,7 @@ Name | Type | Description | Notes
 **language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
 **includes_reports** | **Boolean** |  | [optional] 
 **max_master_payor_admins** | **Integer** |  | [optional] 
+**transmission_types** | [**TransmissionTypes**](TransmissionTypes.md) |  | [optional] 
 
 ## Code Sample
 
@@ -51,7 +52,8 @@ instance = VeloPayments::PayorV1.new(payor_id: null,
                                  reminder_emails_opt_out: null,
                                  language: EN,
                                  includes_reports: null,
-                                 max_master_payor_admins: null)
+                                 max_master_payor_admins: null,
+                                 transmission_types: null)
 ```
 
 

data/docs/PayorV2.md

@@ -6,6 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **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] 
 **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] 
@@ -24,6 +25,7 @@ Name | Type | Description | Notes
 **wu_customer_id** | **String** |  | [optional] 
 **max_master_payor_admins** | **Integer** |  | [optional] 
 **payment_rails** | [**PaymentRails**](PaymentRails.md) |  | [optional] 
+**transmission_types** | [**TransmissionTypes2**](TransmissionTypes2.md) |  | [optional] 
 
 ## Code Sample
 
@@ -32,6 +34,7 @@ require 'VeloPayments'
 
 instance = VeloPayments::PayorV2.new(payor_id: null,
                                  payor_name: Example, Corp,
+                                 payor_xid: ABC_201234,
                                  address: null,
                                  primary_contact_name: Joe Buck,
                                  primary_contact_phone: 123-123-1234,
@@ -49,7 +52,8 @@ instance = VeloPayments::PayorV2.new(payor_id: null,
                                  includes_reports: null,
                                  wu_customer_id: null,
                                  max_master_payor_admins: null,
-                                 payment_rails: null)
+                                 payment_rails: null,
+                                 transmission_types: null)
 ```
 
 

data/docs/PayorsApi.md

@@ -35,7 +35,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 
 begin
   #Get Payor
@@ -51,7 +51,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
 
 ### Return type
 
@@ -87,7 +87,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 
 begin
   #Get Payor
@@ -103,7 +103,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
 
 ### Return type
 
@@ -139,7 +139,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 opts = {
   logo: File.new('/path/to/file') # File | 
 }
@@ -157,7 +157,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
  **logo** | **File**|  | [optional] 
 
 ### Return type
@@ -194,7 +194,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 application_id = 'application_id_example' # String | Application ID
 payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new # PayorCreateApiKeyRequest | Details of application API key to create
 
@@ -212,7 +212,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
  **application_id** | [**String**](.md)| Application ID | 
  **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md)| Details of application API key to create | 
 
@@ -250,7 +250,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new # PayorCreateApplicationRequest | Details of application to create
 
 begin
@@ -266,7 +266,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
  **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md)| Details of application to create | 
 
 ### Return type
@@ -303,7 +303,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
 
 begin
@@ -319,7 +319,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
  **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md)| Reminder Emails Opt-Out Request | 
 
 ### Return type
@@ -356,7 +356,7 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PayorsApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_id = 'payor_id_example' # String | The Payor Id
 
 begin
   #Get Branding
@@ -372,7 +372,7 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The Payor Id | 
 
 ### Return type
 

data/docs/PayoutCompanyV3.md

@@ -0,0 +1,17 @@
+# VeloPayments::PayoutCompanyV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**company_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutCompanyV3.new(company_name: ACME Anvils PLC)
+```
+
+

data/docs/PayoutIndividualV3.md

@@ -0,0 +1,17 @@
+# VeloPayments::PayoutIndividualV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | [**PayoutNameV3**](PayoutNameV3.md) |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutIndividualV3.new(name: null)
+```
+
+

data/docs/PayoutNameV3.md

@@ -0,0 +1,19 @@
+# VeloPayments::PayoutNameV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**first_name** | **String** |  | 
+**last_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutNameV3.new(first_name: Fred,
+                                 last_name: Flintstone)
+```
+
+

data/docs/PayoutPayeeV3.md

@@ -0,0 +1,21 @@
+# VeloPayments::PayoutPayeeV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payee_id** | **String** |  | 
+**individual** | [**PayoutIndividualV3**](PayoutIndividualV3.md) |  | [optional] 
+**company** | [**PayoutCompanyV3**](PayoutCompanyV3.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayoutPayeeV3.new(payee_id: null,
+                                 individual: null,
+                                 company: null)
+```
+
+

data/docs/PayoutServiceApi.md

@@ -0,0 +1,393 @@
+# VeloPayments::PayoutServiceApi
+
+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
+
+> QuoteResponseV3 create_quote_for_payout_v3(payout_id)
+
+Create a quote for the payout
+
+Create quote for a payout
+
+### Example
+
+```ruby
+# load the gem
+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 = 'payout_id_example' # 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 "Exception when calling PayoutServiceApi->create_quote_for_payout_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| Id of the payout | 
+
+### Return type
+
+[**QuoteResponseV3**](QuoteResponseV3.md)
+
+### 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)
+
+Retrieve payments for a payout
+
+Retrieve payments for a payout
+
+### Example
+
+```ruby
+# load the gem
+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 = 'payout_id_example' # String | Id of the payout
+opts = {
+  status: 'status_example', # 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.
+  payor_payment_id: 'payor_payment_id_example', # String | Payor's Id of the Payment
+  source_account_name: 'source_account_name_example', # String | Physical Account Name
+  payment_memo: 'payment_memo_example', # String | Payment Memo of the Payment
+  page_size: 25, # Integer | The number of results to return in a page
+  page: 1 # Integer | Page number. Default is 1.
+}
+
+begin
+  #Retrieve payments for a payout
+  result = api_instance.get_payments_for_payout_v3(payout_id, opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutServiceApi->get_payments_for_payout_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| 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's Id of the Payment | [optional] 
+ **source_account_name** | **String**| Physical Account Name | [optional] 
+ **payment_memo** | **String**| Payment Memo of the Payment | [optional] 
+ **page_size** | **Integer**| The number of results to return in a page | [optional] [default to 25]
+ **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
+
+### Return type
+
+[**PagedPaymentsResponseV3**](PagedPaymentsResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_payout_summary_v3
+
+> PayoutSummaryResponseV3 get_payout_summary_v3(payout_id)
+
+Get Payout Summary
+
+Get payout summary - returns the current state of the payout.
+
+### Example
+
+```ruby
+# load the gem
+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 = 'payout_id_example' # 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 "Exception when calling PayoutServiceApi->get_payout_summary_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| Id of the payout | 
+
+### Return type
+
+[**PayoutSummaryResponseV3**](PayoutSummaryResponseV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## instruct_payout_v3
+
+> instruct_payout_v3(payout_id)
+
+Instruct Payout
+
+Instruct a payout to be made for the specified payoutId.
+
+### Example
+
+```ruby
+# load the gem
+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 = 'payout_id_example' # String | Id of the payout
+
+begin
+  #Instruct Payout
+  api_instance.instruct_payout_v3(payout_id)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutServiceApi->instruct_payout_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| 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
+
+
+## submit_payout_v3
+
+> submit_payout_v3(create_payout_request_v3)
+
+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. 
+
+### Example
+
+```ruby
+# load the gem
+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
+create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new # 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 "Exception when calling PayoutServiceApi->submit_payout_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **create_payout_request_v3** | [**CreatePayoutRequestV3**](CreatePayoutRequestV3.md)| Post amount to transfer using stored funding account details. | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json, multipart/form-data
+- **Accept**: application/json
+
+
+## withdraw_payment
+
+> withdraw_payment(payment_id, withdraw_payment_request)
+
+Withdraw a Payment
+
+<p>withdraw a payment </p> <p>There are a variety of reasons why this can fail</p> <ul>     <li>the payment must be in a state of 'accepted' or 'unfunded'</li>     <li>the payout must not be in a state of 'instructed'</li> </ul> 
+
+### Example
+
+```ruby
+# load the gem
+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
+payment_id = 'payment_id_example' # String | Id of the Payment
+withdraw_payment_request = VeloPayments::WithdrawPaymentRequest.new # WithdrawPaymentRequest | details for withdrawal
+
+begin
+  #Withdraw a Payment
+  api_instance.withdraw_payment(payment_id, withdraw_payment_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutServiceApi->withdraw_payment: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payment_id** | [**String**](.md)| Id of the Payment | 
+ **withdraw_payment_request** | [**WithdrawPaymentRequest**](WithdrawPaymentRequest.md)| details for withdrawal | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## withdraw_payout_v3
+
+> withdraw_payout_v3(payout_id)
+
+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.
+
+### Example
+
+```ruby
+# load the gem
+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 = 'payout_id_example' # String | Id of the payout
+
+begin
+  #Withdraw Payout
+  api_instance.withdraw_payout_v3(payout_id)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayoutServiceApi->withdraw_payout_v3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payout_id** | [**String**](.md)| 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
+