Use v4 instead
This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:
* Payee ID is not found
* If Payee has not been on-boarded
* If Payee is in grace period
* If Payee has existing payments
### 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::PayeesApi.new payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee. begin # Delete Payee by Id api_instance.delete_payee_by_id_v3(payee_id) rescue VeloPayments::ApiError => e puts "Error when calling PayeesApi->delete_payee_by_id_v3: #{e}" end ``` #### Using the delete_payee_by_id_v3_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. >This API will delete Payee by Id (UUID). Deletion by ID is not allowed if:
* Payee ID is not found
* If Payee has not been on-boarded
* If Payee is in grace period
* If Payee has existing payments
### 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::PayeesApi.new payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee. begin # Delete Payee by Id api_instance.delete_payee_by_id_v4(payee_id) rescue VeloPayments::ApiError => e puts "Error when calling PayeesApi->delete_payee_by_id_v4: #{e}" end ``` #### Using the delete_payee_by_id_v4_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. >Use v4 instead
Get Payee by Id
### 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::PayeesApi.new payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee. opts = { sensitive: true # Boolean | Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values. } begin # Get Payee by Id result = api_instance.get_payee_by_id_v3(payee_id, opts) p result rescue VeloPayments::ApiError => e puts "Error when calling PayeesApi->get_payee_by_id_v3: #{e}" end ``` #### Using the get_payee_by_id_v3_with_http_info variant This returns an Array which contains the response data, status code and headers. >Use v4 instead
Get a paginated response listing payee changes.
### 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::PayeesApi.new payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor ID to find associated Payees updated_since = Time.parse('2013-10-20T19:20:30+01:00') # Time | The updatedSince filter in the format YYYY-MM-DDThh:mm:ss+hh:mm opts = { page: 1, # Integer | Page number. Default is 1. page_size: 100 # Integer | Page size. Default is 100. Max allowable is 1000. } begin # List Payee Changes result = api_instance.list_payee_changes_v3(payor_id, updated_since, opts) p result rescue VeloPayments::ApiError => e puts "Error when calling PayeesApi->list_payee_changes_v3: #{e}" end ``` #### Using the list_payee_changes_v3_with_http_info variant This returns an Array which contains the response data, status code and headers. >Use v4 instead
Get a paginated response listing the payees for a payor. ### 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::PayeesApi.new payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID opts = { watchlist_status: VeloPayments::WatchlistStatus::NONE, # WatchlistStatus | The watchlistStatus of the payees. disabled: true, # Boolean | Payee disabled onboarded_status: VeloPayments::OnboardedStatus::CREATED, # OnboardedStatus | The onboarded status of the payees. email: 'bob@example.com', # String | Email address display_name: 'Bob Smith', # String | The display name of the payees. remote_id: 'remoteId123', # String | The remote id of the payees. payee_type: VeloPayments::PayeeType2::INDIVIDUAL, # PayeeType2 | The onboarded status of the payees. payee_country: 'US', # String | The country of the payee - 2 letter ISO 3166-1 country code (upper case) page: 1, # Integer | Page number. Default is 1. page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100. sort: 'displayName:asc' # String | List of sort fields (e.g. ?sort=onboardedStatus:asc,name:asc) Default is name:asc 'name' is treated as company name for companies - last name + ',' + firstName for individuals The supported sort fields are - payeeId, displayName, payoutStatus, onboardedStatus. } begin # List Payees result = api_instance.list_payees_v3(payor_id, opts) p result rescue VeloPayments::ApiError => e puts "Error when calling PayeesApi->list_payees_v3: #{e}" end ``` #### Using the list_payees_v3_with_http_info variant This returns an Array which contains the response data, status code and headers. >Use v4 instead
Update payee details for the given Payee Id.
### 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::PayeesApi.new
payee_id = '2aa5d7e0-2ecb-403f-8494-1865ed0454e9' # String | The UUID of the payee.
update_payee_details_request = VeloPayments::UpdatePayeeDetailsRequest.new # UpdatePayeeDetailsRequest | Request to update payee details
begin
# Update Payee Details
api_instance.payee_details_update_v3(payee_id, update_payee_details_request)
rescue VeloPayments::ApiError => e
puts "Error when calling PayeesApi->payee_details_update_v3: #{e}"
end
```
#### Using the payee_details_update_v3_with_http_info variant
This returns an Array which contains the response data (`nil` in this case), status code and headers.
> Update payee details for the given Payee Id. Payors may only update the payee details if the payee has not yet onboarded Use v4 instead Update the remote Id for the given Payee Id. Update the remote Id for the given Payee Id.