velopayments 2.18.113 → 2.23.78.beta1

data/docs/{GenerateOTPRequest.md → PayoutIndividualV3.md}

@@ -1,17 +1,17 @@
-# VeloPayments::GenerateOTPRequest
+# VeloPayments::PayoutIndividualV3
 
 ## Properties
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | [**OTPType**](OTPType.md) |  | 
+**name** | [**PayoutNameV3**](PayoutNameV3.md) |  | 
 
 ## Code Sample
 
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::GenerateOTPRequest.new(type: null)
+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
+