Sha256: f5ff758fc4def9c914ee06fbd2a2a1060bd149b51898a9092cfc5f9e51f6e59b

Contents?: true

Size: 1.93 KB

Versions: 4

Compression:

Stored size: 1.93 KB

Contents

# SyncteraRubySdk::AddVendorAccountsRequest

## Properties

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **business_id** | **String** | The identifier for the business customer associated with this external account. Exactly one of `business_id` or `customer_id` must be specified.  | [optional] |
| **customer_id** | **String** | The identifier for the personal customer associated with this external account. Exactly one of `customer_id` or `business_id` must be specified.  | [optional] |
| **customer_type** | [**ExtAccountCustomerType**](ExtAccountCustomerType.md) |  |  |
| **vendor** | [**ExternalAccountVendorValues**](ExternalAccountVendorValues.md) |  |  |
| **vendor_access_token** | **String** | The token provided to link external accounts. For Plaid, this is their `access_token`.  | [optional] |
| **vendor_account_ids** | **Array<String>** | The list of vendor account IDs that the customer chose to link. For Plaid, these are `account_id`s.  | [optional] |
| **vendor_customer_id** | **String** | The identifier provided by the vendor for the customer associated with this external account.  | [optional] |
| **verify_owner** | **Boolean** | If true, Synctera will attempt to verify that the external account owner is the same as the customer by comparing external account data to customer data. At least 2 of the following fields must match: name, phone number, email, address. Verification is disabled by default.  | [optional][default to false] |

## Example

```ruby
require 'synctera_ruby_sdk'

instance = SyncteraRubySdk::AddVendorAccountsRequest.new(
  business_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7,
  customer_id: 7d943c51-e4ff-4e57-9558-08cab6b963c7,
  customer_type: null,
  vendor: null,
  vendor_access_token: access-sandbox-de3ce8ef-33f8-452c-a685-8671031fc0f6,
  vendor_account_ids: null,
  vendor_customer_id: 123,
  verify_owner: null
)
```

Version data entries

4 entries across 4 versions & 1 rubygems

Version Path
synctera_ruby_sdk-1.1.3 docs/AddVendorAccountsRequest.md
synctera_ruby_sdk-1.1.2 docs/AddVendorAccountsRequest.md
synctera_ruby_sdk-1.1.1 docs/AddVendorAccountsRequest.md
synctera_ruby_sdk-1.0.0 docs/AddVendorAccountsRequest.md