velopayments 2.17.8 → 2.18.31.beta1

data/docs/PaymentAuditServiceApi.md

@@ -4,13 +4,14 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 
 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**export_transactions_csv**](PaymentAuditServiceApi.md#export_transactions_csv) | **GET** /v4/paymentaudit/transactions | Export Transactions
-[**get_fundings**](PaymentAuditServiceApi.md#get_fundings) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
+[**export_transactions_csvv3**](PaymentAuditServiceApi.md#export_transactions_csvv3) | **GET** /v3/paymentaudit/transactions | Export Transactions
+[**export_transactions_csvv4**](PaymentAuditServiceApi.md#export_transactions_csvv4) | **GET** /v4/paymentaudit/transactions | Export Transactions
+[**get_fundings_v1**](PaymentAuditServiceApi.md#get_fundings_v1) | **GET** /v1/paymentaudit/fundings | Get Fundings for Payor
 [**get_payment_details**](PaymentAuditServiceApi.md#get_payment_details) | **GET** /v3/paymentaudit/payments/{paymentId} | Get Payment
 [**get_payment_details_v4**](PaymentAuditServiceApi.md#get_payment_details_v4) | **GET** /v4/paymentaudit/payments/{paymentId} | Get Payment
 [**get_payments_for_payout**](PaymentAuditServiceApi.md#get_payments_for_payout) | **GET** /v3/paymentaudit/payouts/{payoutId} | Get Payments for Payout
 [**get_payments_for_payout_v4**](PaymentAuditServiceApi.md#get_payments_for_payout_v4) | **GET** /v4/paymentaudit/payouts/{payoutId} | Get Payments for Payout
-[**get_payouts_for_payor**](PaymentAuditServiceApi.md#get_payouts_for_payor) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
+[**get_payouts_for_payor_v3**](PaymentAuditServiceApi.md#get_payouts_for_payor_v3) | **GET** /v3/paymentaudit/payouts | Get Payouts for Payor
 [**get_payouts_for_payor_v4**](PaymentAuditServiceApi.md#get_payouts_for_payor_v4) | **GET** /v4/paymentaudit/payouts | Get Payouts for Payor
 [**list_payment_changes**](PaymentAuditServiceApi.md#list_payment_changes) | **GET** /v1/deltas/payments | List Payment Changes
 [**list_payments_audit**](PaymentAuditServiceApi.md#list_payments_audit) | **GET** /v3/paymentaudit/payments | Get List of Payments
@@ -18,9 +19,67 @@ Method | HTTP request | Description
 
 
 
-## export_transactions_csv
+## export_transactions_csvv3
 
-> String export_transactions_csv(opts)
+> PayorAmlTransactionV3 export_transactions_csvv3(opts)
+
+Export Transactions
+
+Download a CSV file containing payments in a date range. Uses Transfer-Encoding - chunked to stream to the client. Date range is inclusive of both the start and end dates.
+
+### 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::PaymentAuditServiceApi.new
+opts = {
+  payor_id: 'payor_id_example', # String | The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor. 
+  start_date: Date.parse('2013-10-20'), # Date | Start date, inclusive. Format is YYYY-MM-DD
+  end_date: Date.parse('2013-10-20') # Date | End date, inclusive. Format is YYYY-MM-DD
+}
+
+begin
+  #Export Transactions
+  result = api_instance.export_transactions_csvv3(opts)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PaymentAuditServiceApi->export_transactions_csvv3: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The Payor ID for whom you wish to run the report. For a Payor requesting the report, this could be their exact Payor, or it could be a child/descendant Payor.  | [optional] 
+ **start_date** | **Date**| Start date, inclusive. Format is YYYY-MM-DD | [optional] 
+ **end_date** | **Date**| End date, inclusive. Format is YYYY-MM-DD | [optional] 
+
+### Return type
+
+[**PayorAmlTransactionV3**](PayorAmlTransactionV3.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/csv
+
+
+## export_transactions_csvv4
+
+> PayorAmlTransactionV4 export_transactions_csvv4(opts)
 
 Export Transactions
 
@@ -47,10 +106,10 @@ opts = {
 
 begin
   #Export Transactions
-  result = api_instance.export_transactions_csv(opts)
+  result = api_instance.export_transactions_csvv4(opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PaymentAuditServiceApi->export_transactions_csv: #{e}"
+  puts "Exception when calling PaymentAuditServiceApi->export_transactions_csvv4: #{e}"
 end
 ```
 
@@ -66,7 +125,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-**String**
+[**PayorAmlTransactionV4**](PayorAmlTransactionV4.md)
 
 ### Authorization
 
@@ -78,9 +137,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/csv
 
 
-## get_fundings
+## get_fundings_v1
 
-> GetFundingsResponse get_fundings(opts)
+> GetFundingsResponse get_fundings_v1(opts)
 
 Get Fundings for Payor
 
@@ -107,10 +166,10 @@ opts = {
 
 begin
   #Get Fundings for Payor
-  result = api_instance.get_fundings(opts)
+  result = api_instance.get_fundings_v1(opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PaymentAuditServiceApi->get_fundings: #{e}"
+  puts "Exception when calling PaymentAuditServiceApi->get_fundings_v1: #{e}"
 end
 ```
 
@@ -406,9 +465,9 @@ Name | Type | Description  | Notes
 - **Accept**: application/json
 
 
-## get_payouts_for_payor
+## get_payouts_for_payor_v3
 
-> GetPayoutsResponseV3 get_payouts_for_payor(payor_id, opts)
+> GetPayoutsResponseV3 get_payouts_for_payor_v3(payor_id, opts)
 
 Get Payouts for Payor
 
@@ -439,10 +498,10 @@ opts = {
 
 begin
   #Get Payouts for Payor
-  result = api_instance.get_payouts_for_payor(payor_id, opts)
+  result = api_instance.get_payouts_for_payor_v3(payor_id, opts)
   p result
 rescue VeloPayments::ApiError => e
-  puts "Exception when calling PaymentAuditServiceApi->get_payouts_for_payor: #{e}"
+  puts "Exception when calling PaymentAuditServiceApi->get_payouts_for_payor_v3: #{e}"
 end
 ```
 
@@ -476,7 +535,7 @@ Name | Type | Description  | Notes
 
 ## get_payouts_for_payor_v4
 
-> GetPayoutsResponseV4 get_payouts_for_payor_v4(payor_id, opts)
+> GetPayoutsResponseV4 get_payouts_for_payor_v4(opts)
 
 Get Payouts for Payor
 
@@ -494,20 +553,21 @@ VeloPayments.configure do |config|
 end
 
 api_instance = VeloPayments::PaymentAuditServiceApi.new
-payor_id = 'payor_id_example' # String | The account owner Payor ID
 opts = {
+  payor_id: 'payor_id_example', # String | The id (UUID) of the payor funding the payout or the payor whose payees are being paid.
   payout_memo: 'payout_memo_example', # String | Payout Memo filter - case insensitive sub-string match
   status: 'status_example', # String | Payout Status
   submitted_date_from: Date.parse('2013-10-20'), # Date | The submitted date from range filter. Format is yyyy-MM-dd.
   submitted_date_to: Date.parse('2013-10-20'), # Date | The submitted date to range filter. Format is yyyy-MM-dd.
+  from_payor_name: 'from_payor_name_example', # String | The name of the payor whose payees are being paid. This filters via a case insensitive substring match.
   page: 1, # Integer | Page number. Default is 1.
   page_size: 25, # Integer | Page size. Default is 25. Max allowable is 100.
-  sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status. 
+  sort: 'sort_example' # String | List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments 
 }
 
 begin
   #Get Payouts for Payor
-  result = api_instance.get_payouts_for_payor_v4(payor_id, opts)
+  result = api_instance.get_payouts_for_payor_v4(opts)
   p result
 rescue VeloPayments::ApiError => e
   puts "Exception when calling PaymentAuditServiceApi->get_payouts_for_payor_v4: #{e}"
@@ -519,14 +579,15 @@ end
 
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
- **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_id** | [**String**](.md)| The id (UUID) of the payor funding the payout or the payor whose payees are being paid. | [optional] 
  **payout_memo** | **String**| Payout Memo filter - case insensitive sub-string match | [optional] 
  **status** | **String**| Payout Status | [optional] 
  **submitted_date_from** | **Date**| The submitted date from range filter. Format is yyyy-MM-dd. | [optional] 
  **submitted_date_to** | **Date**| The submitted date to range filter. Format is yyyy-MM-dd. | [optional] 
+ **from_payor_name** | **String**| The name of the payor whose payees are being paid. This filters via a case insensitive substring match. | [optional] 
  **page** | **Integer**| Page number. Default is 1. | [optional] [default to 1]
  **page_size** | **Integer**| Page size. Default is 25. Max allowable is 100. | [optional] [default to 25]
- **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status.  | [optional] 
+ **sort** | **String**| List of sort fields (e.g. ?sort=submittedDateTime:asc,instructedDateTime:asc,status:asc) Default is submittedDateTime:asc The supported sort fields are: submittedDateTime, instructedDateTime, status, totalPayments  | [optional] 
 
 ### Return type
 
@@ -694,7 +755,7 @@ Name | Type | Description  | Notes
 
 ## list_payments_audit_v4
 
-> ListPaymentsResponse list_payments_audit_v4(opts)
+> ListPaymentsResponseV4 list_payments_audit_v4(opts)
 
 Get List of Payments
 
@@ -770,7 +831,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ListPaymentsResponse**](ListPaymentsResponse.md)
+[**ListPaymentsResponseV4**](ListPaymentsResponseV4.md)
 
 ### Authorization
 

data/docs/PaymentRails.md

@@ -0,0 +1,16 @@
+# VeloPayments::PaymentRails
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentRails.new()
+```
+
+

data/docs/PaymentResponseV3.md

@@ -4,39 +4,42 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_id** | **String** |  | 
-**payee_id** | **String** |  | 
-**payor_id** | **String** |  | 
-**payor_name** | **String** |  | [optional] 
-**quote_id** | **String** |  | 
-**source_account_id** | **String** |  | 
-**source_account_name** | **String** |  | [optional] 
-**remote_id** | **String** |  | [optional] 
-**source_amount** | **Integer** |  | [optional] 
+**payment_id** | **String** | The id of the payment | 
+**payee_id** | **String** | The id of the paymeee | 
+**payor_id** | **String** | The id of the payor | 
+**payor_name** | **String** | The name of the payor | [optional] 
+**quote_id** | **String** | The quote Id used for the FX | 
+**source_account_id** | **String** | The id of the source account from which the payment was taken | 
+**source_account_name** | **String** | The name of the source account from which the payment was taken | [optional] 
+**remote_id** | **String** | The remote id by which the payor refers to the payee. Only populated once payment is confirmed | [optional] 
+**source_amount** | **Integer** | The source amount for the payment (amount debited to make the payment) | [optional] 
 **source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
-**payment_amount** | **Integer** |  | 
+**payment_amount** | **Integer** | The amount which the payee will receive | 
 **payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) |  | [optional] 
-**rate** | **Float** |  | [optional] 
-**inverted_rate** | **Float** |  | [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** |  | 
 **status** | **String** |  | 
-**funding_status** | **String** |  | 
-**routing_number** | **String** |  | [optional] 
-**account_number** | **String** |  | [optional] 
-**iban** | **String** |  | [optional] 
-**payment_memo** | **String** |  | [optional] 
-**filename_reference** | **String** |  | [optional] 
-**individual_identification_number** | **String** |  | [optional] 
-**trace_number** | **String** |  | [optional] 
+**funding_status** | **String** | The funding status of the payment | 
+**routing_number** | **String** | The routing number for the payment. | [optional] 
+**account_number** | **String** | The account number for the account which will receive the payment. | [optional] 
+**iban** | **String** | The iban for the payment. | [optional] 
+**payment_memo** | **String** | The payment memo set by the payor | [optional] 
+**filename_reference** | **String** | ACH file payment was submitted in, if applicable | [optional] 
+**individual_identification_number** | **String** | Individual Identification Number assigned to the payment in the ACH file, if applicable | [optional] 
+**trace_number** | **String** | Trace Number assigned to the payment in the ACH file, if applicable | [optional] 
 **payor_payment_id** | **String** |  | [optional] 
 **payment_channel_id** | **String** |  | [optional] 
 **payment_channel_name** | **String** |  | [optional] 
 **account_name** | **String** |  | [optional] 
-**rails_id** | **String** |  | 
-**country_code** | **String** |  | [optional] 
+**rails_id** | **String** | The rails ID. Default value is RAILS ID UNAVAILABLE when not populated. | [default to 'RAILS ID UNAVAILABLE']
+**country_code** | **String** | The country code of the payment channel. | [optional] 
 **events** | [**Array<PaymentEventResponseV3>**](PaymentEventResponseV3.md) |  | 
-**return_cost** | **Integer** |  | [optional] 
+**return_cost** | **Integer** | The return cost if a returned payment. | [optional] 
 **return_reason** | **String** |  | [optional] 
+**rails_payment_id** | **String** |  | [optional] 
+**rails_batch_id** | **String** |  | [optional] 
+**rejection_reason** | **String** |  | [optional] 
 
 ## Code Sample
 
@@ -75,7 +78,10 @@ instance = VeloPayments::PaymentResponseV3.new(payment_id: null,
                                  country_code: US,
                                  events: null,
                                  return_cost: 1232,
-                                 return_reason: Some Reason Value)
+                                 return_reason: Some Reason Value,
+                                 rails_payment_id: null,
+                                 rails_batch_id: null,
+                                 rejection_reason: null)
 ```
 
 

data/docs/PaymentResponseV4.md

@@ -4,39 +4,42 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**payment_id** | **String** |  | 
-**payee_id** | **String** |  | 
-**payor_id** | **String** | Deprecated in v2.16. Will be populated with submitting payor ID until removed in a later release. | 
-**payor_name** | **String** |  | [optional] 
-**quote_id** | **String** |  | 
-**source_account_id** | **String** |  | 
-**source_account_name** | **String** |  | [optional] 
-**remote_id** | **String** |  | [optional] 
-**source_amount** | **Integer** |  | [optional] 
+**payment_id** | **String** | The id of the payment | 
+**payee_id** | **String** | The id of the paymeee | 
+**payor_id** | **String** | The id of the payor | 
+**payor_name** | **String** | The name of the payor | [optional] 
+**quote_id** | **String** | The quote Id used for the FX | 
+**source_account_id** | **String** | The id of the source account from which the payment was taken | 
+**source_account_name** | **String** | The name of the source account from which the payment was taken | [optional] 
+**remote_id** | **String** | The remote id by which the payor refers to the payee. Only populated once payment is confirmed | [optional] 
+**source_amount** | **Integer** | The source amount for the payment (amount debited to make the payment) | [optional] 
 **source_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
-**payment_amount** | **Integer** |  | 
+**payment_amount** | **Integer** | The amount which the payee will receive | 
 **payment_currency** | [**PaymentAuditCurrencyV4**](PaymentAuditCurrencyV4.md) |  | [optional] 
-**rate** | **Float** |  | [optional] 
-**inverted_rate** | **Float** |  | [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** |  | 
 **status** | **String** |  | 
-**funding_status** | **String** |  | 
-**routing_number** | **String** |  | [optional] 
-**account_number** | **String** |  | [optional] 
-**iban** | **String** |  | [optional] 
-**payment_memo** | **String** |  | [optional] 
-**filename_reference** | **String** |  | [optional] 
-**individual_identification_number** | **String** |  | [optional] 
-**trace_number** | **String** |  | [optional] 
+**funding_status** | **String** | The funding status of the payment | 
+**routing_number** | **String** | The routing number for the payment. | [optional] 
+**account_number** | **String** | The account number for the account which will receive the payment. | [optional] 
+**iban** | **String** | The iban for the payment. | [optional] 
+**payment_memo** | **String** | The payment memo set by the payor | [optional] 
+**filename_reference** | **String** | ACH file payment was submitted in, if applicable | [optional] 
+**individual_identification_number** | **String** | Individual Identification Number assigned to the payment in the ACH file, if applicable | [optional] 
+**trace_number** | **String** | Trace Number assigned to the payment in the ACH file, if applicable | [optional] 
 **payor_payment_id** | **String** |  | [optional] 
 **payment_channel_id** | **String** |  | [optional] 
 **payment_channel_name** | **String** |  | [optional] 
 **account_name** | **String** |  | [optional] 
-**rails_id** | **String** |  | 
-**country_code** | **String** |  | [optional] 
+**rails_id** | **String** | The rails ID. Default value is RAILS ID UNAVAILABLE when not populated. | [default to 'RAILS ID UNAVAILABLE']
+**country_code** | **String** | The country code of the payment channel. | [optional] 
 **events** | [**Array<PaymentEventResponseV4>**](PaymentEventResponseV4.md) |  | 
-**return_cost** | **Integer** |  | [optional] 
+**return_cost** | **Integer** | The return cost if a returned payment. | [optional] 
 **return_reason** | **String** |  | [optional] 
+**rails_payment_id** | **String** |  | [optional] 
+**rails_batch_id** | **String** |  | [optional] 
+**rejection_reason** | **String** |  | [optional] 
 **payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) |  | [optional] 
 
 ## Code Sample
@@ -50,9 +53,9 @@ instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  payor_name: null,
                                  quote_id: null,
                                  source_account_id: null,
-                                 source_account_name: null,
-                                 remote_id: null,
-                                 source_amount: null,
+                                 source_account_name: My Account,
+                                 remote_id: aasdf123,
+                                 source_amount: 12345,
                                  source_currency: null,
                                  payment_amount: null,
                                  payment_currency: null,
@@ -61,22 +64,25 @@ instance = VeloPayments::PaymentResponseV4.new(payment_id: null,
                                  submitted_date_time: null,
                                  status: null,
                                  funding_status: null,
-                                 routing_number: null,
-                                 account_number: null,
-                                 iban: null,
-                                 payment_memo: null,
-                                 filename_reference: null,
-                                 individual_identification_number: null,
-                                 trace_number: null,
-                                 payor_payment_id: null,
-                                 payment_channel_id: null,
-                                 payment_channel_name: null,
-                                 account_name: null,
-                                 rails_id: null,
-                                 country_code: null,
+                                 routing_number: 123123123123,
+                                 account_number: 123123232323,
+                                 iban: DE89 3704 0044 0532 0130 00,
+                                 payment_memo: Payment memo,
+                                 filename_reference: file ref,
+                                 individual_identification_number: 1231231adf,
+                                 trace_number: abodu123,
+                                 payor_payment_id: 123123asdf,
+                                 payment_channel_id: 123asdf,
+                                 payment_channel_name: My Payment Channel,
+                                 account_name: My Account Name,
+                                 rails_id: asdf123,
+                                 country_code: US,
                                  events: null,
-                                 return_cost: null,
-                                 return_reason: null,
+                                 return_cost: 1232,
+                                 return_reason: Some Reason Value,
+                                 rails_payment_id: null,
+                                 rails_batch_id: null,
+                                 rejection_reason: null,
                                  payout: null)
 ```
 

data/docs/PaymentResponseV4Payout.md

@@ -4,6 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
+**payout_id** | **String** |  | [optional] 
 **payout_from** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 **payout_to** | [**PayoutPayorV4**](PayoutPayorV4.md) |  | [optional] 
 
@@ -12,7 +13,8 @@ Name | Type | Description | Notes
 ```ruby
 require 'VeloPayments'
 
-instance = VeloPayments::PaymentResponseV4Payout.new(payout_from: null,
+instance = VeloPayments::PaymentResponseV4Payout.new(payout_id: null,
+                                 payout_from: null,
                                  payout_to: null)
 ```
 

data/docs/PayorAmlTransactionV3.md

@@ -0,0 +1,71 @@
+# VeloPayments::PayorAmlTransactionV3
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_date** | **Date** |  | [optional] 
+**transaction_time** | **String** |  | [optional] 
+**report_transaction_type** | **String** |  | [optional] 
+**debit** | **Integer** |  | [optional] 
+**debit_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**credit** | **Integer** |  | [optional] 
+**credit_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**return_fee** | **String** |  | [optional] 
+**return_fee_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**return_fee_description** | **String** |  | [optional] 
+**return_code** | **String** |  | [optional] 
+**return_description** | **String** |  | [optional] 
+**funding_type** | **String** |  | [optional] 
+**date_funding_requested** | **String** |  | [optional] 
+**payee_name** | **String** |  | [optional] 
+**remote_id** | **String** | Remote ID of the Payee, set by Payor | [optional] 
+**payee_type** | **String** |  | [optional] 
+**payee_email** | **String** |  | [optional] 
+**source_account** | **String** |  | [optional] 
+**payment_amount** | **Integer** |  | [optional] 
+**payment_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**payment_memo** | **String** |  | [optional] 
+**payment_type** | **String** |  | [optional] 
+**payment_rails** | **String** |  | [optional] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_status** | **String** |  | [optional] 
+**reject_reason** | **String** |  | [optional] 
+**fx_applied** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorAmlTransactionV3.new(transaction_date: null,
+                                 transaction_time: null,
+                                 report_transaction_type: null,
+                                 debit: null,
+                                 debit_currency: null,
+                                 credit: null,
+                                 credit_currency: null,
+                                 return_fee: null,
+                                 return_fee_currency: null,
+                                 return_fee_description: null,
+                                 return_code: null,
+                                 return_description: null,
+                                 funding_type: null,
+                                 date_funding_requested: null,
+                                 payee_name: null,
+                                 remote_id: null,
+                                 payee_type: null,
+                                 payee_email: null,
+                                 source_account: null,
+                                 payment_amount: null,
+                                 payment_currency: null,
+                                 payment_memo: null,
+                                 payment_type: null,
+                                 payment_rails: null,
+                                 payor_payment_id: null,
+                                 payment_status: null,
+                                 reject_reason: null,
+                                 fx_applied: null)
+```
+
+

data/docs/PayorAmlTransactionV4.md

@@ -0,0 +1,71 @@
+# VeloPayments::PayorAmlTransactionV4
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**transaction_date** | **Date** |  | [optional] 
+**transaction_time** | **String** |  | [optional] 
+**report_transaction_type** | **String** |  | [optional] 
+**debit** | **Integer** |  | [optional] 
+**debit_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**credit** | **Integer** |  | [optional] 
+**credit_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**return_fee** | **String** |  | [optional] 
+**return_fee_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**return_fee_description** | **String** |  | [optional] 
+**return_code** | **String** |  | [optional] 
+**return_description** | **String** |  | [optional] 
+**funding_type** | **String** |  | [optional] 
+**date_funding_requested** | **String** |  | [optional] 
+**payee_name** | **String** |  | [optional] 
+**remote_id** | **String** | Remote ID of the Payee, set by Payor | [optional] 
+**payee_type** | **String** |  | [optional] 
+**payee_email** | **String** |  | [optional] 
+**source_account** | **String** |  | [optional] 
+**payment_amount** | **Integer** |  | [optional] 
+**payment_currency** | **String** | ISO 4217 3 character currency code | [optional] 
+**payment_memo** | **String** |  | [optional] 
+**payment_type** | **String** |  | [optional] 
+**payment_rails** | **String** |  | [optional] 
+**payor_payment_id** | **String** |  | [optional] 
+**payment_status** | **String** |  | [optional] 
+**reject_reason** | **String** |  | [optional] 
+**fx_applied** | **Float** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorAmlTransactionV4.new(transaction_date: null,
+                                 transaction_time: null,
+                                 report_transaction_type: null,
+                                 debit: null,
+                                 debit_currency: null,
+                                 credit: null,
+                                 credit_currency: null,
+                                 return_fee: null,
+                                 return_fee_currency: null,
+                                 return_fee_description: null,
+                                 return_code: null,
+                                 return_description: null,
+                                 funding_type: null,
+                                 date_funding_requested: null,
+                                 payee_name: null,
+                                 remote_id: null,
+                                 payee_type: null,
+                                 payee_email: null,
+                                 source_account: null,
+                                 payment_amount: null,
+                                 payment_currency: null,
+                                 payment_memo: null,
+                                 payment_type: null,
+                                 payment_rails: null,
+                                 payor_payment_id: null,
+                                 payment_status: null,
+                                 reject_reason: null,
+                                 fx_applied: null)
+```
+
+

data/docs/PayorV1.md

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
 **funding_account_routing_number** | **String** | The funding account routing number to be used for the payor. | [optional] 
 **funding_account_account_number** | **String** | The funding account number to be used for the payor. | [optional] 
 **funding_account_account_name** | **String** | The funding account name to be used for the payor. | [optional] 
-**kyc_state** | **String** | The kyc state of the payor. | [optional] [readonly] 
+**kyc_state** | [**KycState**](KycState.md) |  | [optional] 
 **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] 
 **payee_grace_period_processing_enabled** | **Boolean** | Whether grace period processing is enabled. | [optional] [readonly] 
 **payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] [readonly] 
@@ -40,7 +40,7 @@ instance = VeloPayments::PayorV1.new(payor_id: null,
                                  funding_account_routing_number: 123456789,
                                  funding_account_account_number: 1234567890123,
                                  funding_account_account_name: Example Corp BOA,
-                                 kyc_state: PASSED_KYC,
+                                 kyc_state: null,
                                  manual_lockout: null,
                                  payee_grace_period_processing_enabled: null,
                                  payee_grace_period_days: null,