RubyGems - velopayments - Versions diffs - 2.35.58 → 2.37.150.beta1 - Mend

velopayments 2.35.58 → 2.37.150.beta1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (336) hide show

data/docs/PaymentChannelResponseV4.md ADDED Viewed

@@ -0,0 +1,56 @@
+# VeloPayments::PaymentChannelResponseV4
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **payee_id** | **String** |  | [optional] |
+| **payment_channel_name** | **String** |  |  |
+| **account_name** | **String** |  |  |
+| **channel_type** | **String** | Payment channel type. One of the following values: CHANNEL_BANK |  |
+| **country_code** | **String** | Valid ISO 3166 2 character country code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-3166-country-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. |  |
+| **routing_number** | **String** |  | [optional] |
+| **account_number** | **String** |  | [optional] |
+| **iban** | **String** | Must match the regular expression &#x60;&#x60;&#x60;^[A-Za-z0-9]+$&#x60;&#x60;&#x60;. | [optional] |
+| **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. |  |
+| **payor_ids** | **Array&lt;String&gt;** |  | [optional] |
+| **payee_name** | **String** |  | [optional] |
+| **bank_name** | **String** |  | [optional] |
+| **bank_swift_bic** | **String** |  | [optional] |
+| **bank_address** | [**AddressV4**](AddressV4.md) |  | [optional] |
+| **deleted** | **Boolean** |  | [optional] |
+| **enabled** | **Boolean** |  | [optional] |
+| **disabled_reason_code** | **String** |  | [optional] |
+| **disabled_reason** | **String** |  | [optional] |
+| **payable** | **Boolean** | Whether this payment channel is payable | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PaymentChannelResponseV4.new(
+  id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3,
+  payee_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3,
+  payment_channel_name: My Payment Channel,
+  account_name: My Account,
+  channel_type: CHANNEL_BANK,
+  country_code: US,
+  routing_number: XXXXX6789,
+  account_number: XXXXXX5678,
+  iban: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1234,
+  currency: USD,
+  payor_ids: null,
+  payee_name: John Stuart,
+  bank_name: HSBC Bank plc,
+  bank_swift_bic: MIDLGB22,
+  bank_address: null,
+  deleted: null,
+  enabled: null,
+  disabled_reason_code: disabled reason code,
+  disabled_reason: disabled reason,
+  payable: null
+)
+```

data/docs/PaymentChannelSummaryV4.md ADDED Viewed

@@ -0,0 +1,32 @@
+# VeloPayments::PaymentChannelSummaryV4
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_channel_id** | **String** |  |  |
+| **name** | **String** | The payment channel name |  |
+| **country_code** | **String** | Valid ISO 3166 2 character country code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-3166-country-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. |  |
+| **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. |  |
+| **last4_digits** | **String** | The last 4 digits of the account number or IBAN | [optional] |
+| **enabled** | **Boolean** | Usually true. False if an associated payment is returned |  |
+| **disabled_reason** | **String** | Indicates why the payment channel was disabled | [optional] |
+| **disabled_reason_code** | **String** |  | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PaymentChannelSummaryV4.new(
+  payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3,
+  name: Bank of America USD,
+  country_code: US,
+  currency: USD,
+  last4_digits: 1234,
+  enabled: false,
+  disabled_reason: User request,
+  disabled_reason_code: VR100
+)
+```

data/docs/PaymentChannelsResponseV4.md ADDED Viewed

@@ -0,0 +1,20 @@
+# VeloPayments::PaymentChannelsResponseV4
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payment_channels** | [**Array&lt;PaymentChannelResponseV4&gt;**](PaymentChannelResponseV4.md) |  | [optional] |
+| **payor_to_payment_channel_mappings** | [**Array&lt;PayorToPaymentChannelMappingV4&gt;**](PayorToPaymentChannelMappingV4.md) |  | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PaymentChannelsResponseV4.new(
+  payment_channels: null,
+  payor_to_payment_channel_mappings: null
+)
+```

data/docs/PaymentInstructionV3.md CHANGED Viewed

@@ -8,9 +8,10 @@
 | **currency** | **String** | Valid ISO 4217 3 letter currency code. See the &lt;a href&#x3D;\&quot;https://www.iso.org/iso-4217-currency-codes.html\&quot; target&#x3D;\&quot;_blank\&quot; a&gt;ISO specification&lt;/a&gt; for details. |  |
 | **amount** | **Integer** | &lt;p&gt;Amount to send to Payee&lt;/p&gt; &lt;p&gt;The maximum payment amount is dependent on the currency&lt;/p&gt;  |  |
 | **payment_memo** | **String** | &lt;p&gt;Any value here will override the memo value in the parent payout&lt;/p&gt; &lt;p&gt;This should be the reference field on the statement seen by the payee (but not via ACH)&lt;/p&gt;  | [optional] |
-| **source_account_name** | **String** | Must match a valid source account name belonging to the payor |  |
+| **source_account_name** | **String** | Must match a valid source account name belonging to the payor. Exactly one of sourceAccountName or transactionId is required. | [optional] |
+| **transaction_id** | **String** | Must match a valid transaction id previously created by the payor. Exactly one of sourceAccountName or transactionId is required. | [optional] |
 | **payor_payment_id** | **String** | A reference identifier for the payor for the given payee payment | [optional] |
-| **transmission_type** | **String** | Optionally choose a specific transmission method for the payment | [optional] |
+| **transmission_type** | **String** | &lt;p&gt;Optionally choose a specific transmission method for the payment.&lt;/p&gt; &lt;p&gt;Valid values for transmissionType can be found attached to the Source Account&lt;/p&gt;  | [optional] |
 | **remote_system_id** | **String** | &lt;p&gt;The identifier for the remote payments system if not Velo&lt;/p&gt; &lt;p&gt;Should only be used after consultation with Velo Payments&lt;/p&gt;  | [optional] |
 | **payment_metadata** | **String** | &lt;p&gt;Metadata about the payment that may be relevant to the specific rails or remote system making the payout&lt;/p&gt; &lt;p&gt;The structure of the data will be dictated by the requirements of the payment rails&lt;/p&gt;  | [optional] |
@@ -25,6 +26,7 @@ instance = VeloPayments::PaymentInstructionV3.new(
   amount: 1299,
   payment_memo: my memo,
   source_account_name: MyAccountName,
+  transaction_id: 859af785-223b-4d5b-a708-5fa57f006dbb,
   payor_payment_id: 123211321ABSD,
   transmission_type: ACH,
   remote_system_id: null,

data/docs/PaymentResponseV4.md CHANGED Viewed

@@ -43,14 +43,19 @@
 | **return_reason** | **String** |  | [optional] |
 | **rails_payment_id** | **String** |  | [optional] |
 | **rails_batch_id** | **String** |  | [optional] |
+| **rails_account_id** | **String** |  | [optional] |
 | **payment_scheme** | **String** |  | [optional] |
 | **rejection_reason** | **String** |  | [optional] |
+| **rails_rejection_information** | **String** | The original reason that the payment was rejected. This can be third party rails specific if rejected by the underlying third party rails logic. | [optional] |
 | **withdrawn_reason** | **String** |  | [optional] |
 | **withdrawable** | **Boolean** |  | [optional] |
 | **auto_withdrawn_reason_code** | **String** | Populated with rejection reason code if the payment was withdrawn automatically at instruct time | [optional] |
 | **transmission_type** | **String** | The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE, GACHO | [optional] |
+| **transmission_type_requested** | **String** | The transmission type of the payment requested by the payor | [optional] |
 | **payment_tracking_reference** | **String** |  | [optional] |
 | **payment_metadata** | **String** | Metadata for the payment | [optional] |
+| **transaction_id** | **String** |  | [optional] |
+| **transaction_reference** | **String** |  | [optional] |
 | **schedule** | [**PayoutSchedule**](PayoutSchedule.md) |  | [optional] |
 | **post_instruct_fx_info** | [**PostInstructFxInfo**](PostInstructFxInfo.md) |  | [optional] |
 | **payout** | [**PaymentResponseV4Payout**](PaymentResponseV4Payout.md) |  | [optional] |
@@ -100,14 +105,19 @@ instance = VeloPayments::PaymentResponseV4.new(
   return_reason: Some Reason Value,
   rails_payment_id: null,
   rails_batch_id: null,
+  rails_account_id: null,
   payment_scheme: null,
   rejection_reason: null,
+  rails_rejection_information: null,
   withdrawn_reason: null,
   withdrawable: null,
   auto_withdrawn_reason_code: null,
   transmission_type: null,
+  transmission_type_requested: null,
   payment_tracking_reference: null,
   payment_metadata: sample metadata,
+  transaction_id: null,
+  transaction_reference: null,
   schedule: null,
   post_instruct_fx_info: null,
   payout: null

data/docs/PaymentV3.md CHANGED Viewed

@@ -14,11 +14,12 @@
 | **payee** | [**PayoutPayeeV3**](PayoutPayeeV3.md) |  | [optional] |
 | **withdrawable** | **Boolean** | Can this paynent be withdrawn | [optional] |
 | **status** | **String** | Current status of payment. One of the following values: SUBMITTED, ACCEPTED, REJECTED, WITHDRAWN, RETURNED, AWAITING_FUNDS, FUNDED, UNFUNDED, CANCELLED, BANK_PAYMENT_REQUESTED | [optional] |
-| **transmission_type** | **String** | The transmission method of the payment. One of the following values: ACH, SAME_DAY_ACH, WIRE, LOCAL, SWIFT | [optional] |
+| **transmission_type** | **String** | &lt;p&gt;The transmission method of the payment.&lt;/p&gt; &lt;p&gt;Valid values for transmissionType can be found attached to the Source Account&lt;/p&gt;  | [optional] |
 | **remote_system_id** | **String** | &lt;p&gt;The identifier for the remote payments system if not Velo&lt;/p&gt;  | [optional] |
 | **payment_metadata** | **String** | &lt;p&gt;Metadata about the payment that may be relevant to the specific rails or remote system making the payout&lt;/p&gt; &lt;p&gt;The structure of the data will be dictated by the requirements of the payment rails&lt;/p&gt;  | [optional] |
 | **auto_withdrawn_reason_code** | **String** | Populated only if the payment was automatically withdrawn during instruction for being invalid | [optional] |
 | **rails_id** | **String** | Indicates the 3rd party system involved in making this payment | [optional] |
+| **transaction_id** | **String** | The id of the transaction associated with this payment if there was one | [optional] |
 ## Example
@@ -40,7 +41,8 @@ instance = VeloPayments::PaymentV3.new(
   remote_system_id: OB012,
   payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567,
   auto_withdrawn_reason_code: VE0003,
-  rails_id: SVB
+  rails_id: SVB,
+  transaction_id: 859af785-223b-4d5b-a708-5fa57f006dbb
 )
 ```

data/docs/PayorCreateApiKeyRequest.md CHANGED Viewed

@@ -14,9 +14,9 @@
 require 'velopayments'
 instance = VeloPayments::PayorCreateApiKeyRequest.new(
-  name: iOS Key,
-  description: Key for iOS mobile application,
-  roles: [&quot;velo.payor.admin&quot;]
+  name: SAP Key 01,
+  description: An API Key for the SAP Application,
+  roles: [&quot;payor.admin&quot;]
 )
 ```

data/docs/PayorFundingDetected.md ADDED Viewed

@@ -0,0 +1,46 @@
+# VeloPayments::PayorFundingDetected
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | **String** | OA3 Schema type name for the source info which is used as the discriminator value to ensure that data binding works correctly |  |
+| **event_id** | **String** | UUID id of the source event in the Velo platform |  |
+| **created_at** | **Time** | ISO8601 timestamp indicating when the source event was created |  |
+| **rails_id** | **String** | the identifier of the payment rail from which funding was received | [optional] |
+| **payor_id** | **String** | ID of the payor within the Velo platform |  |
+| **funding_request_id** | **String** | ID of this funding transaction within the Velo platform |  |
+| **funding_ref** | **String** | the external identity reference for this funding transaction | [optional] |
+| **currency** | **String** | the ISO-4217 code for the currency in which the funding was made | [optional] |
+| **amount** | **Integer** | the received funding amount in currency minor units | [optional] |
+| **physical_account_name** | **String** | the name of the account as registered with the payment rail | [optional] |
+| **source_account_name** | **String** | the name of the account as registered with the Velo platform | [optional] |
+| **source_account_id** | **String** | the ID of the account as registered with the Velo platform | [optional] |
+| **additional_information** | **String** | any additional information received from the payment rail | [optional] |
+| **transaction_id** | **String** | The Id of the related transaction | [optional] |
+| **transaction_reference** | **String** | The payors own reference for the related transaction | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PayorFundingDetected.new(
+  source_type: payment_status_changed,
+  event_id: 270ab907-27ec-4b83-8028-0ff432bbdec4,
+  created_at: 2020-06-18T15:09:42Z,
+  rails_id: WUBS,
+  payor_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  funding_request_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  funding_ref: some-ref-text,
+  currency: GBP,
+  amount: 1234,
+  physical_account_name: Acme Company Ltd,
+  source_account_name: Acme Co UK,
+  source_account_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  additional_information: any additional information,
+  transaction_id: 4d88e559-d057-45b1-8d8b-b9ccc06f4503,
+  transaction_reference: myInvoiceNumber-1234567890
+)
+```

data/docs/PayorFundingDetectedAllOf.md ADDED Viewed

@@ -0,0 +1,40 @@
+# VeloPayments::PayorFundingDetectedAllOf
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **rails_id** | **String** | the identifier of the payment rail from which funding was received | [optional] |
+| **payor_id** | **String** | ID of the payor within the Velo platform |  |
+| **funding_request_id** | **String** | ID of this funding transaction within the Velo platform |  |
+| **funding_ref** | **String** | the external identity reference for this funding transaction | [optional] |
+| **currency** | **String** | the ISO-4217 code for the currency in which the funding was made | [optional] |
+| **amount** | **Integer** | the received funding amount in currency minor units | [optional] |
+| **physical_account_name** | **String** | the name of the account as registered with the payment rail | [optional] |
+| **source_account_name** | **String** | the name of the account as registered with the Velo platform | [optional] |
+| **source_account_id** | **String** | the ID of the account as registered with the Velo platform | [optional] |
+| **additional_information** | **String** | any additional information received from the payment rail | [optional] |
+| **transaction_id** | **String** | The Id of the related transaction | [optional] |
+| **transaction_reference** | **String** | The payors own reference for the related transaction | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PayorFundingDetectedAllOf.new(
+  rails_id: WUBS,
+  payor_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  funding_request_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  funding_ref: some-ref-text,
+  currency: GBP,
+  amount: 1234,
+  physical_account_name: Acme Company Ltd,
+  source_account_name: Acme Co UK,
+  source_account_id: cbd9280f-8fde-4190-b014-979d88f3ec54,
+  additional_information: any additional information,
+  transaction_id: 4d88e559-d057-45b1-8d8b-b9ccc06f4503,
+  transaction_reference: myInvoiceNumber-1234567890
+)
+```

data/docs/PayorToPaymentChannelMappingV4.md ADDED Viewed

@@ -0,0 +1,20 @@
+# VeloPayments::PayorToPaymentChannelMappingV4
+## Properties
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payor_id** | **String** |  | [optional] |
+| **payment_channel_id** | **String** |  | [optional] |
+## Example
+```ruby
+require 'velopayments'
+instance = VeloPayments::PayorToPaymentChannelMappingV4.new(
+  payor_id: 9ac75325-5dcd-42d5-b992-175d7e0a035e,
+  payment_channel_id: 70faaff7-2c32-4b44-b27f-f0b6c484e6f3
+)
+```

data/docs/PayorV2.md CHANGED Viewed

@@ -4,33 +4,33 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** |  | [readonly] |
-| **payor_name** | **String** | The name of the payor. |  |
+| **payor_id** | **String** | The Payor Id |  |
+| **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] |
 | **provider** | **String** | The source of the payorXid, default is null which means Velo | [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] |
 | **primary_contact_email** | **String** | Primary contact email for the payor. | [optional] |
-| **kyc_state** | **String** | The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC | [optional][readonly] |
+| **kyc_state** | **String** | The kyc state of the payor. One of the following values: FAILED_KYC, PASSED_KYC, REQUIRES_KYC | [optional] |
 | **manual_lockout** | **Boolean** | Whether or not the payor has been manually locked by the backoffice. | [optional] |
 | **open_banking_enabled** | **Boolean** | Is Open Banking supported for this payor | [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] |
+| **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 before the payee must be onboarded. | [optional] |
 | **collective_alias** | **String** | How the payor has chosen to refer to payees. | [optional] |
 | **support_contact** | **String** | The payor’s support contact email address. | [optional] |
 | **dba_name** | **String** | The payor’s &#39;Doing Business As&#39; 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][readonly] |
+| **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] |
-| **wu_customer_id** | **String** |  | [optional] |
-| **max_master_payor_admins** | **Integer** |  | [optional] |
-| **payment_rails** | **String** | The id of the payment rails | [optional] |
-| **transmission_types** | [**TransmissionTypes2**](TransmissionTypes2.md) |  | [optional] |
-| **remote_system_ids** | **Array&lt;String&gt;** | The payor’s supported remote systems by id | [optional] |
-| **usd_txn_value_reporting_threshold** | **Integer** | USD in minor units | [optional] |
-| **managing_payees** | **Boolean** |  | [optional] |
+| **includes_reports** | **Boolean** | For internal use only (will be removed in a later version) | [optional] |
+| **wu_customer_id** | **String** | For internal use only (will be removed in a later version) | [optional] |
+| **max_master_payor_admins** | **Integer** | The maximum number of payor users with the master admin role | [optional] |
+| **payment_rails** | **String** | For internal use only (will be removed in a later version) | [optional] |
+| **remote_system_ids** | **Array&lt;String&gt;** | For internal use only (will be removed in a later version) | [optional] |
+| **usd_txn_value_reporting_threshold** | **Integer** | USD in minor units. For internal use only (will be removed in a later version) | [optional] |
+| **managing_payees** | **Boolean** | Does this payor manage their own payees (payees are not invited but managed by the payor) | [optional] |
+| **created_at** | **Time** | The date of creation of the payor | [optional] |
 ## Example
@@ -39,7 +39,7 @@ require 'velopayments'
 instance = VeloPayments::PayorV2.new(
   payor_id: null,
-  payor_name: Example, Corp,
+  payor_name: Example Corp,
   payor_xid: ABC_201234,
   provider: null,
   address: null,
@@ -51,7 +51,7 @@ instance = VeloPayments::PayorV2.new(
   open_banking_enabled: null,
   payee_grace_period_processing_enabled: null,
   payee_grace_period_days: null,
-  collective_alias: Payee,
+  collective_alias: Vendors,
   support_contact: support@example.com,
   dba_name: Some Biz,
   allows_language_choice: null,
@@ -59,12 +59,12 @@ instance = VeloPayments::PayorV2.new(
   language: EN,
   includes_reports: null,
   wu_customer_id: null,
-  max_master_payor_admins: null,
+  max_master_payor_admins: 5,
   payment_rails: null,
-  transmission_types: null,
   remote_system_ids: null,
   usd_txn_value_reporting_threshold: 1000000,
-  managing_payees: null
+  managing_payees: null,
+  created_at: 2021-12-08T14:41:02.354982Z
 )
 ```

data/docs/PayorsApi.md CHANGED Viewed

@@ -4,7 +4,6 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**get_payor_by_id_v1**](PayorsApi.md#get_payor_by_id_v1) | **GET** /v1/payors/{payorId} | Get Payor |
 | [**get_payor_by_id_v2**](PayorsApi.md#get_payor_by_id_v2) | **GET** /v2/payors/{payorId} | Get Payor |
 | [**payor_add_payor_logo_v1**](PayorsApi.md#payor_add_payor_logo_v1) | **POST** /v1/payors/{payorId}/branding/logos | Add Logo |
 | [**payor_create_api_key_v1**](PayorsApi.md#payor_create_api_key_v1) | **POST** /v1/payors/{payorId}/applications/{applicationId}/keys | Create API Key |
@@ -13,75 +12,6 @@ All URIs are relative to *https://api.sandbox.velopayments.com*
 | [**payor_get_branding**](PayorsApi.md#payor_get_branding) | **GET** /v1/payors/{payorId}/branding | Get Branding |
-## get_payor_by_id_v1
-> <PayorV1> get_payor_by_id_v1(payor_id)
-Get Payor
-<p>Get a Single Payor by Id.</p> <p>deprecated since v2.10 - Use /v2/payors
-### 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::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
-begin
-  # Get Payor
-  result = api_instance.get_payor_by_id_v1(payor_id)
-  p result
-rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->get_payor_by_id_v1: #{e}"
-end
-```
-#### Using the get_payor_by_id_v1_with_http_info variant
-This returns an Array which contains the response data, status code and headers.
-> <Array(<PayorV1>, Integer, Hash)> get_payor_by_id_v1_with_http_info(payor_id)
-```ruby
-begin
-  # Get Payor
-  data, status_code, headers = api_instance.get_payor_by_id_v1_with_http_info(payor_id)
-  p status_code # => 2xx
-  p headers # => { ... }
-  p data # => <PayorV1>
-rescue VeloPayments::ApiError => e
-  puts "Error when calling PayorsApi->get_payor_by_id_v1_with_http_info: #{e}"
-end
-```
-### Parameters
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
-### Return type
-[**PayorV1**](PayorV1.md)
-### Authorization
-[OAuth2](../README.md#OAuth2)
-### HTTP request headers
-- **Content-Type**: Not defined
-- **Accept**: application/json
 ## get_payor_by_id_v2
 > <PayorV2> get_payor_by_id_v2(payor_id)
@@ -102,7 +32,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 begin
   # Get Payor
@@ -135,7 +65,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 ### Return type
@@ -171,7 +101,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 opts = {
   logo: File.new('/path/to/some/file') # File |
 }
@@ -206,7 +136,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **logo** | **File** |  | [optional] |
 ### Return type
@@ -229,7 +159,7 @@ nil (empty response body)
 Create API Key
-<p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p>
+<p>Create an an API key for the given payor Id and application Id</p> <p>You can create multiple API Keys for a given application</p> <p>API Keys are programmatic users for integrating your application with the Velo platform</p> <p>The response will return the API Key and the secret. This is the only time you will be able to see the secret</p>
 ### Examples
@@ -243,9 +173,9 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 application_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Application ID
-payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'iOS Key', roles: ["velo.payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
+payor_create_api_key_request = VeloPayments::PayorCreateApiKeyRequest.new({name: 'SAP Key 01', roles: ["payor.admin"]}) # PayorCreateApiKeyRequest | Details of application API key to create
 begin
   # Create API Key
@@ -278,7 +208,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **application_id** | **String** | Application ID |  |
 | **payor_create_api_key_request** | [**PayorCreateApiKeyRequest**](PayorCreateApiKeyRequest.md) | Details of application API key to create |  |
@@ -316,7 +246,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 payor_create_application_request = VeloPayments::PayorCreateApplicationRequest.new({name: 'SAP'}) # PayorCreateApplicationRequest | Details of application to create
 begin
@@ -349,7 +279,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **payor_create_application_request** | [**PayorCreateApplicationRequest**](PayorCreateApplicationRequest.md) | Details of application to create |  |
 ### Return type
@@ -386,7 +316,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 payor_email_opt_out_request = VeloPayments::PayorEmailOptOutRequest.new({reminder_emails_opt_out: false}) # PayorEmailOptOutRequest | Reminder Emails Opt-Out Request
 begin
@@ -419,7 +349,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 | **payor_email_opt_out_request** | [**PayorEmailOptOutRequest**](PayorEmailOptOutRequest.md) | Reminder Emails Opt-Out Request |  |
 ### Return type
@@ -456,7 +386,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayorsApi.new
-payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The Payor Id
+payor_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The account owner Payor ID
 begin
   # Get Branding
@@ -489,7 +419,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **payor_id** | **String** | The Payor Id |  |
+| **payor_id** | **String** | The account owner Payor ID |  |
 ### Return type

data/docs/PayoutsApi.md CHANGED Viewed

@@ -178,7 +178,7 @@ opts = {
   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
-  transmission_type: 'ACH', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
+  transmission_type: 'transmission_type_example', # String | Transmission Type * ACH * SAME_DAY_ACH * WIRE
   payment_memo: 'payment_memo_example', # String | Payment Memo of the Payment
   page_size: 56, # Integer | The number of results to return in a page
   page: 56 # Integer | Page number. Default is 1.
@@ -472,7 +472,7 @@ VeloPayments.configure do |config|
 end
 api_instance = VeloPayments::PayoutsApi.new
-create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new({payments: [VeloPayments::PaymentInstructionV3.new({remote_id: 'remoteId1234', currency: 'USD', amount: 1299, source_account_name: 'MyAccountName'})]}) # CreatePayoutRequestV3 | Post amount to transfer using stored funding account details.
+create_payout_request_v3 = VeloPayments::CreatePayoutRequestV3.new({payments: [VeloPayments::PaymentInstructionV3.new({remote_id: 'remoteId1234', currency: 'USD', amount: 1299})]}) # CreatePayoutRequestV3 | Post amount to transfer using stored funding account details.
 begin
   # Submit Payout

data/docs/SourceAccountResponseV3.md CHANGED Viewed

@@ -22,6 +22,7 @@
 | **deleted** | **Boolean** | An optional flag for whether the source account has been deleted. Only present in the response if true. | [optional] |
 | **user_deleted** | **Boolean** | An optional flag for whether the source account has been deleted by a user. Only present in the response if true. | [optional] |
 | **deleted_at** | **Time** | An optional timestamp when the source account has been deleted. Only present in the response if deleted. | [optional] |
+| **transmission_types** | **Array&lt;String&gt;** | List of supported transmission types. | [optional] |
 ## Example
@@ -46,7 +47,8 @@ instance = VeloPayments::SourceAccountResponseV3.new(
   country: US,
   deleted: null,
   user_deleted: null,
-  deleted_at: 2021-01-27T10:08:25.701Z
+  deleted_at: 2021-01-27T10:08:25.701Z,
+  transmission_types: [&quot;ACH&quot;,&quot;SAME_DAY_ACH&quot;]
 )
 ```