velopayments 2.11.73

data/docs/PaymentChannel.md

@@ -0,0 +1,29 @@
+# VeloPayments::PaymentChannel
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payment_channel_name** | **String** |  | [optional] 
+**iban** | **String** | Must match the regular expression ```^[A-Za-z0-9]+$```. | [optional] 
+**account_number** | **String** |  | 
+**routing_no** | **String** |  | 
+**country_code** | **String** | Must be a 3 character currency code. ISO 4217 | 
+**currency** | **String** |  | 
+**account_name** | **String** |  | 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentChannel.new(payment_channel_name: null,
+                                 iban: null,
+                                 account_number: null,
+                                 routing_no: null,
+                                 country_code: null,
+                                 currency: null,
+                                 account_name: null)
+```
+
+

data/docs/PaymentChannelCountry.md

@@ -0,0 +1,19 @@
+# VeloPayments::PaymentChannelCountry
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**iso_country_code** | **String** |  | [optional] 
+**rules** | [**Array<PaymentChannelRule>**](PaymentChannelRule.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentChannelCountry.new(iso_country_code: null,
+                                 rules: null)
+```
+
+

data/docs/PaymentChannelRule.md

@@ -0,0 +1,29 @@
+# VeloPayments::PaymentChannelRule
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**element** | **String** |  | [optional] 
+**required** | **Boolean** |  | [optional] 
+**display_name** | **String** |  | [optional] 
+**min_length** | **Integer** |  | [optional] 
+**max_length** | **Integer** |  | [optional] 
+**validation** | **String** |  | [optional] 
+**display_order** | **Integer** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentChannelRule.new(element: null,
+                                 required: null,
+                                 display_name: null,
+                                 min_length: null,
+                                 max_length: null,
+                                 validation: null,
+                                 display_order: null)
+```
+
+

data/docs/PaymentChannelRulesResponse.md

@@ -0,0 +1,17 @@
+# VeloPayments::PaymentChannelRulesResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**bank** | [**Array<PaymentChannelCountry>**](PaymentChannelCountry.md) |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentChannelRulesResponse.new(bank: null)
+```
+
+

data/docs/PaymentEventResponse.md

@@ -0,0 +1,39 @@
+# VeloPayments::PaymentEventResponse
+
+## Properties
+
+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_type** | **String** | The type of the event. | 
+**source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**source_amount** | **Float** | The source amount exposed by the event. | [optional] 
+**payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**payment_amount** | **Float** | The destination amount exposed by the event. | [optional] 
+**account_number** | **String** | The account number attached to the event. | [optional] 
+**routing_number** | **String** | The routing number attached to the event. | [optional] 
+**iban** | **String** |  | [optional] 
+**account_name** | **String** |  | [optional] 
+**principal** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentEventResponse.new(event_id: null,
+                                 event_date_time: null,
+                                 event_type: null,
+                                 source_currency: null,
+                                 source_amount: null,
+                                 payment_currency: null,
+                                 payment_amount: null,
+                                 account_number: null,
+                                 routing_number: null,
+                                 iban: null,
+                                 account_name: null,
+                                 principal: null)
+```
+
+

data/docs/PaymentInstruction.md

@@ -0,0 +1,27 @@
+# VeloPayments::PaymentInstruction
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**remote_id** | **String** | Your identifier for payee | 
+**currency** | **String** | Payee's currency | 
+**amount** | **Integer** | Amount to send to Payee | 
+**payment_memo** | **String** |  | [optional] 
+**source_account_name** | **String** |  | 
+**payor_payment_id** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentInstruction.new(remote_id: null,
+                                 currency: null,
+                                 amount: null,
+                                 payment_memo: null,
+                                 source_account_name: null,
+                                 payor_payment_id: null)
+```
+
+

data/docs/PaymentResponse.md

@@ -0,0 +1,81 @@
+# VeloPayments::PaymentResponse
+
+## Properties
+
+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] 
+**source_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**payment_amount** | **Integer** |  | 
+**payment_currency** | [**PaymentAuditCurrency**](PaymentAuditCurrency.md) |  | [optional] 
+**rate** | **Float** |  | [optional] 
+**inverted_rate** | **Float** |  | [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] 
+**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] 
+**events** | [**Array<PaymentEventResponse>**](PaymentEventResponse.md) |  | 
+**return_cost** | **Integer** |  | [optional] 
+**return_reason** | **String** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PaymentResponse.new(payment_id: null,
+                                 payee_id: null,
+                                 payor_id: null,
+                                 payor_name: null,
+                                 quote_id: null,
+                                 source_account_id: null,
+                                 source_account_name: null,
+                                 remote_id: null,
+                                 source_amount: null,
+                                 source_currency: null,
+                                 payment_amount: null,
+                                 payment_currency: null,
+                                 rate: null,
+                                 inverted_rate: 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,
+                                 events: null,
+                                 return_cost: null,
+                                 return_reason: null)
+```
+
+

data/docs/Payor.md

@@ -0,0 +1,55 @@
+# VeloPayments::Payor
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_id** | **String** |  | [optional] 
+**payor_name** | **String** | The name of the payor. | 
+**address** | [**Address**](Address.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] 
+**primary_contact_email** | **String** | Primary contact email for the payor. | [optional] 
+**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] 
+**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] 
+**payee_grace_period_days** | **Integer** | The grace period for paying payees in days. | [optional] 
+**collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] 
+**support_contact** | **String** | The payor’s support contact address. | [optional] 
+**dba_name** | **String** | The payor’s 'Doing Business As' name. | [optional] 
+**allows_language_choice** | **Boolean** | Whether or not the payor allows language choice in the UI. | [optional] 
+**reminder_emails_opt_out** | **Boolean** | Whether or not the payor has opted-out of reminder emails being sent. | [optional] 
+**language** | **String** | The payor’s language preference. Must be one of [EN, FR]. | [optional] 
+**includes_reports** | **Boolean** |  | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::Payor.new(payor_id: null,
+                                 payor_name: null,
+                                 address: null,
+                                 primary_contact_name: null,
+                                 primary_contact_phone: null,
+                                 primary_contact_email: null,
+                                 funding_account_routing_number: null,
+                                 funding_account_account_number: null,
+                                 funding_account_account_name: null,
+                                 kyc_state: null,
+                                 manual_lockout: null,
+                                 payee_grace_period_processing_enabled: null,
+                                 payee_grace_period_days: null,
+                                 collective_alias: null,
+                                 support_contact: null,
+                                 dba_name: null,
+                                 allows_language_choice: null,
+                                 reminder_emails_opt_out: null,
+                                 language: null,
+                                 includes_reports: null)
+```
+
+

data/docs/PayorApplicationsApi.md

@@ -0,0 +1,119 @@
+# VeloPayments::PayorApplicationsApi
+
+All URIs are relative to *https://api.sandbox.velopayments.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**payor_create_api_key_request**](PayorApplicationsApi.md#payor_create_api_key_request) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key
+[**payor_create_application_request**](PayorApplicationsApi.md#payor_create_application_request) | **POST** /v1/payors/{payorId}/applications | Create Application
+
+
+
+## payor_create_api_key_request
+
+> PayorCreateApiKeyResponse payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+
+Create API Key
+
+Create an an API key for the given payor Id and application Id
+
+### 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::PayorApplicationsApi.new
+payor_id = 'payor_id_example' # String | The account owner 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
+
+begin
+  #Create API Key
+  result = api_instance.payor_create_api_key_request(payor_id, application_id, payor_create_api_key_request)
+  p result
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorApplicationsApi->payor_create_api_key_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **application_id** | [**String**](.md)| Application ID | 
+ **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md)| Details of application API key to create | 
+
+### Return type
+
+[**PayorCreateApiKeyResponse**](PayorCreateApiKeyResponse.md)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## payor_create_application_request
+
+> payor_create_application_request(payor_id, payor_create_application_request)
+
+Create Application
+
+Create an application for the given Payor ID
+
+### 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::PayorApplicationsApi.new
+payor_id = 'payor_id_example' # String | The account owner Payor ID
+payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new # PayorCreateApplicationRequest | Details of application to create
+
+begin
+  #Create Application
+  api_instance.payor_create_application_request(payor_id, payor_create_application_request)
+rescue VeloPayments::ApiError => e
+  puts "Exception when calling PayorApplicationsApi->payor_create_application_request: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **payor_id** | [**String**](.md)| The account owner Payor ID | 
+ **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md)| Details of application to create | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[OAuth2](../README.md#OAuth2)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/PayorBrandingResponse.md

@@ -0,0 +1,25 @@
+# VeloPayments::PayorBrandingResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**payor_name** | **String** | The name of the payor | 
+**logo_url** | **String** | The URL to use for this payor’s logo | 
+**collective_alias** | **String** | How the payor has chosen to refer to payees | [optional] 
+**support_contact** | **String** | The payor’s support contact address | [optional] 
+**dba_name** | **String** | The payor’s 'Doing Business As' name | [optional] 
+
+## Code Sample
+
+```ruby
+require 'VeloPayments'
+
+instance = VeloPayments::PayorBrandingResponse.new(payor_name: null,
+                                 logo_url: null,
+                                 collective_alias: null,
+                                 support_contact: null,
+                                 dba_name: null)
+```
+
+