SyncteraRubySdk::AccountsApi

All URIs are relative to https://api.synctera.com/v0

Method	HTTP request	Description
create_account	POST /accounts	Create an account
create_account_relationship	POST /accounts/account_id/relationships	Create account relationship
create_account_resource_product	POST /accounts/products	Create an account product
create_account_template	POST /accounts/templates	Create an account template
delete_account_relationship	DELETE /accounts/account_id/relationships/relationship_id	Delete account relationship
delete_account_template	DELETE /accounts/templates/template_id	Delete account template
get_account	GET /accounts/account_id	Get account
get_account_relationship	GET /accounts/account_id/relationships/relationship_id	Get account relationship
get_account_template	GET /accounts/templates/template_id	Get account template
list_account_relationship	GET /accounts/account_id/relationships	List account relationships
list_account_resource_products	GET /accounts/products	List account products
list_account_templates	GET /accounts/templates	List account templates
list_accounts	GET /accounts	List accounts
patch_account	PATCH /accounts/account_id	Patch account
patch_account_product	PATCH /accounts/products/product_id	Patch account product
update_account	PUT /accounts/account_id	Update account
update_account_relationship	PUT /accounts/account_id/relationships/relationship_id	Update account relationship
update_account_template	PUT /accounts/templates/template_id	Update account template

create_account

create_account(account_creation, opts)

Create an account

Creates an account copying values from account template into the account resource. Any fields defined as part of account creation will overwrite the ones provided from the account template. Required fields: - relationships

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_creation = SyncteraRubySdk::AccountCreation.new # AccountCreation | Account to create
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Create an account
  result = api_instance.create_account(account_creation, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account: #{e}"
end

Using the create_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_account_with_http_info(account_creation, opts)

begin
  # Create an account
  data, status_code, headers = api_instance.create_account_with_http_info(account_creation, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGenericResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_creation	AccountCreation	Account to create
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

AccountGenericResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

create_account_relationship

create_account_relationship(account_id, relationship, opts)

Create account relationship

Add a customer to an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
relationship = SyncteraRubySdk::Relationship.new({relationship_type: SyncteraRubySdk::AccountRelationshipType::PRIMARY_ACCOUNT_HOLDER}) # Relationship | Account relationship object
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Create account relationship
  result = api_instance.create_account_relationship(account_id, relationship, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_relationship: #{e}"
end

Using the create_account_relationship_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_account_relationship_with_http_info(account_id, relationship, opts)

begin
  # Create account relationship
  data, status_code, headers = api_instance.create_account_relationship_with_http_info(account_id, relationship, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RelationshipResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_relationship_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
relationship	Relationship	Account relationship object
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

RelationshipResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

create_account_resource_product

create_account_resource_product(account_product, opts)

Create an account product

Create an account product. Rates cannot be nil or empty.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_product = SyncteraRubySdk::Fee.new({amount: 3.56, currency: 'currency_example', fee_type: 'MONTHLY_FEE', product_type: 'INTEREST'}) # AccountProduct | Account product to create
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Create an account product
  result = api_instance.create_account_resource_product(account_product, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_resource_product: #{e}"
end

Using the create_account_resource_product_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_account_resource_product_with_http_info(account_product, opts)

begin
  # Create an account product
  data, status_code, headers = api_instance.create_account_resource_product_with_http_info(account_product, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountProduct>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_resource_product_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_product	AccountProduct	Account product to create
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

AccountProduct

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

create_account_template

create_account_template(account_template, opts)

Create an account template

Create an account template. An account template is needed to create an account in a lead mode.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_template = SyncteraRubySdk::AccountTemplate.new({is_enabled: false, name: 'name_example', template: SyncteraRubySdk::TemplateFieldsChargeSecured.new({account_type: SyncteraRubySdk::AccountType::SAVING, bank_country: 'US', currency: 'USD', minimum_payment: SyncteraRubySdk::MinimumPaymentTypeFull.new({type: SyncteraRubySdk::MinimumPaymentType::RATE_OR_AMOUNT})})}) # AccountTemplate | Account template to create
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Create an account template
  result = api_instance.create_account_template(account_template, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_template: #{e}"
end

Using the create_account_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> create_account_template_with_http_info(account_template, opts)

begin
  # Create an account template
  data, status_code, headers = api_instance.create_account_template_with_http_info(account_template, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountTemplateResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->create_account_template_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_template	AccountTemplate	Account template to create
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

AccountTemplateResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

delete_account_relationship

delete_account_relationship(account_id, relationship_id)

Delete account relationship

Delete account relationship

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
relationship_id = '1a582c51-e4ff-4e57-9558-08cab6b963aa' # String | Relationship ID of the account associate with the account entity

begin
  # Delete account relationship
  result = api_instance.delete_account_relationship(account_id, relationship_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->delete_account_relationship: #{e}"
end

Using the delete_account_relationship_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> delete_account_relationship_with_http_info(account_id, relationship_id)

begin
  # Delete account relationship
  data, status_code, headers = api_instance.delete_account_relationship_with_http_info(account_id, relationship_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->delete_account_relationship_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
relationship_id	String	Relationship ID of the account associate with the account entity

Return type

DeleteResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

delete_account_template

delete_account_template(template_id)

Delete account template

Delete account template

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
template_id = 'a8943c51-e4ff-4e57-9558-08cab6b963c0' # String | Account Template ID

begin
  # Delete account template
  result = api_instance.delete_account_template(template_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->delete_account_template: #{e}"
end

Using the delete_account_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> delete_account_template_with_http_info(template_id)

begin
  # Delete account template
  data, status_code, headers = api_instance.delete_account_template_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeleteResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->delete_account_template_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String	Account Template ID

Return type

DeleteResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

get_account

get_account(account_id)

Get account

Get an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.

begin
  # Get account
  result = api_instance.get_account(account_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account: #{e}"
end

Using the get_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_account_with_http_info(account_id)

begin
  # Get account
  data, status_code, headers = api_instance.get_account_with_http_info(account_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGenericResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.

Return type

AccountGenericResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

get_account_relationship

get_account_relationship(account_id, relationship_id)

Get account relationship

Get account relationship by ID

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
relationship_id = '1a582c51-e4ff-4e57-9558-08cab6b963aa' # String | Relationship ID of the account associate with the account entity

begin
  # Get account relationship
  result = api_instance.get_account_relationship(account_id, relationship_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account_relationship: #{e}"
end

Using the get_account_relationship_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_account_relationship_with_http_info(account_id, relationship_id)

begin
  # Get account relationship
  data, status_code, headers = api_instance.get_account_relationship_with_http_info(account_id, relationship_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RelationshipResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account_relationship_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
relationship_id	String	Relationship ID of the account associate with the account entity

Return type

RelationshipResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

get_account_template

get_account_template(template_id)

Get account template

Get an account template

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
template_id = 'a8943c51-e4ff-4e57-9558-08cab6b963c0' # String | Account Template ID

begin
  # Get account template
  result = api_instance.get_account_template(template_id)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account_template: #{e}"
end

Using the get_account_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> get_account_template_with_http_info(template_id)

begin
  # Get account template
  data, status_code, headers = api_instance.get_account_template_with_http_info(template_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountTemplateResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->get_account_template_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String	Account Template ID

Return type

AccountTemplateResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

list_account_relationship

list_account_relationship(account_id, opts)

List account relationships

List all customers of an account

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
opts = {
  limit: 100, # Integer | 
  page_token: 'a8937a0d' # String | 
}

begin
  # List account relationships
  result = api_instance.list_account_relationship(account_id, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_relationship: #{e}"
end

Using the list_account_relationship_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_account_relationship_with_http_info(account_id, opts)

begin
  # List account relationships
  data, status_code, headers = api_instance.list_account_relationship_with_http_info(account_id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RelationshipList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_relationship_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
limit	Integer		[optional][default to 100]
page_token	String		[optional]

Return type

RelationshipList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

list_account_resource_products

list_account_resource_products(product_type, opts)

List account products

List account Products

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
product_type = 'FEE' # String | Type of account product
opts = {
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  start_date: Date.parse('2013-10-20'), # Date | Date range filtering for type INTEREST. All rates in interest resource have to have valid_from later or equal to start_date.
  end_date: Date.parse('2013-10-20'), # Date | Date range filtering for type INTEREST. All rates in interest resource have to have valid_to earlier or equal to end_date.
  id: 'id_example' # String | ID of account product. Multiple IDs can be provided as a comma-separated list.
}

begin
  # List account products
  result = api_instance.list_account_resource_products(product_type, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_resource_products: #{e}"
end

Using the list_account_resource_products_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_account_resource_products_with_http_info(product_type, opts)

begin
  # List account products
  data, status_code, headers = api_instance.list_account_resource_products_with_http_info(product_type, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountProductList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_resource_products_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
product_type	String	Type of account product
limit	Integer		[optional][default to 100]
page_token	String		[optional]
start_date	Date	Date range filtering for type INTEREST. All rates in interest resource have to have valid_from later or equal to start_date.	[optional]
end_date	Date	Date range filtering for type INTEREST. All rates in interest resource have to have valid_to earlier or equal to end_date.	[optional]
id	String	ID of account product. Multiple IDs can be provided as a comma-separated list.	[optional]

Return type

AccountProductList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

list_account_templates

list_account_templates(opts)

List account templates

List account templates

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
opts = {
  account_type: SyncteraRubySdk::AccountType::SAVING, # AccountType | The type of the account 
  limit: 100, # Integer | 
  page_token: 'a8937a0d' # String | 
}

begin
  # List account templates
  result = api_instance.list_account_templates(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_templates: #{e}"
end

Using the list_account_templates_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_account_templates_with_http_info(opts)

begin
  # List account templates
  data, status_code, headers = api_instance.list_account_templates_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TemplateList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_account_templates_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_type	AccountType	The type of the account	[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]

Return type

TemplateList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

list_accounts

list_accounts(opts)

List accounts

Get paginated list of Accounts associated

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
opts = {
  id: ['inner_example'], # Array<String> | Account ID(s). Multiple IDs can be provided as a comma-separated list. 
  account_type: SyncteraRubySdk::AccountType::SAVING, # AccountType | The type of the account 
  linked_account_id: ['inner_example'], # Array<String> | Return only resources that are linked to the specified backing account in balance_floor or balance_ceiling. Multiple IDs can be provided as a comma-separated list. 
  overdraft_account_id: ['inner_example'], # Array<String> | Overdraft account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead. 
  overflow_account_id: ['inner_example'], # Array<String> | Overflow account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead. 
  account_number: ['inner_example'], # Array<String> | Account number(s). Multiple account numbers can be provided as a comma-separated list. When only a single account number is provided, any * characters in the string are wildcards, and match any characters. 
  status: SyncteraRubySdk::Status::APPLICATION_SUBMITTED, # Status | 
  interest_product_id: 'interest_product_id_example', # String | Interest product ID that accounts associate with. Multiple IDs can be provided as a comma-separated list.
  customer_type: SyncteraRubySdk::CustomerType::BUSINESS, # CustomerType | Customer type of the account, BUSINESS or PERSONAL 
  spend_control_ids: ['7d943c51-e4ff-4e57-9558-08cab6b963c7'], # Array<String> | Spend Control ID(s). Multiple IDs can be provided as a comma-separated list. Return only resources that use the specified Spend Controls. 
  nickname: 'nickname_example', # String | Nickname of the account 
  customer_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | The customer's unique identifier
  business_id: ['inner_example'], # Array<String> | Unique identifier for the business. Multiple IDs can be provided as a comma-separated list. 
  person_id: ['inner_example'], # Array<String> | Unique identifier for the person. Multiple IDs can be provided as a comma-separated list. 
  first_name: 'Alice', # String | 
  last_name: 'Smith', # String | 
  limit: 100, # Integer | 
  page_token: 'a8937a0d', # String | 
  sort_by: ['account_number:asc'] # Array<String> | Specifies the sort order for the returned accounts. 
}

begin
  # List accounts
  result = api_instance.list_accounts(opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_accounts: #{e}"
end

Using the list_accounts_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> list_accounts_with_http_info(opts)

begin
  # List accounts
  data, status_code, headers = api_instance.list_accounts_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountList>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->list_accounts_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Array<String>	Account ID(s). Multiple IDs can be provided as a comma-separated list.	[optional]
account_type	AccountType	The type of the account	[optional]
linked_account_id	Array<String>	Return only resources that are linked to the specified backing account in balance_floor or balance_ceiling. Multiple IDs can be provided as a comma-separated list.	[optional]
overdraft_account_id	Array<String>	Overdraft account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.	[optional]
overflow_account_id	Array<String>	Overflow account ID(s). Multiple IDs can be provided as a comma-separated list. This parameter is deprecated and will be removed in a future API version. Use linked_account_id instead.	[optional]
account_number	Array<String>	Account number(s). Multiple account numbers can be provided as a comma-separated list. When only a single account number is provided, any * characters in the string are wildcards, and match any characters.	[optional]
status	Status		[optional]
interest_product_id	String	Interest product ID that accounts associate with. Multiple IDs can be provided as a comma-separated list.	[optional]
customer_type	CustomerType	Customer type of the account, BUSINESS or PERSONAL	[optional]
spend_control_ids	Array<String>	Spend Control ID(s). Multiple IDs can be provided as a comma-separated list. Return only resources that use the specified Spend Controls.	[optional]
nickname	String	Nickname of the account	[optional]
customer_id	String	The customer's unique identifier	[optional]
business_id	Array<String>	Unique identifier for the business. Multiple IDs can be provided as a comma-separated list.	[optional]
person_id	Array<String>	Unique identifier for the person. Multiple IDs can be provided as a comma-separated list.	[optional]
first_name	String		[optional]
last_name	String		[optional]
limit	Integer		[optional][default to 100]
page_token	String		[optional]
sort_by	Array<String>	Specifies the sort order for the returned accounts.	[optional]

Return type

AccountList

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json, application/problem+json

patch_account

patch_account(account_id, patch_account, opts)

Patch account

Patch account. Immutable fields: - account_number - account_type - account_template_id - customer_type Please note: - Other fields cannot be modified when access_status is FROZEN. - access_status has to be patched individually without other fields.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
patch_account = SyncteraRubySdk::PatchAccount.new # PatchAccount | Account fields to be patched
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Patch account
  result = api_instance.patch_account(account_id, patch_account, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->patch_account: #{e}"
end

Using the patch_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> patch_account_with_http_info(account_id, patch_account, opts)

begin
  # Patch account
  data, status_code, headers = api_instance.patch_account_with_http_info(account_id, patch_account, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGenericResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->patch_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
patch_account	PatchAccount	Account fields to be patched
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

AccountGenericResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

patch_account_product

patch_account_product(product_id, patch_account_product, opts)

Patch account product

Patch account product. Rates requires at minimum 1 entry if specified.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
product_id = '92113c51-e4ff-4e57-9558-08cab6b963dd' # String | Account Product ID
patch_account_product = SyncteraRubySdk::Fee.new({amount: 3.56, currency: 'currency_example', fee_type: 'MONTHLY_FEE', product_type: 'INTEREST'}) # PatchAccountProduct | Account product fields to be patched
opts = {
  idempotency_key: '7d943c51-e4ff-4e57-9558-08cab6b963c7' # String | An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
}

begin
  # Patch account product
  result = api_instance.patch_account_product(product_id, patch_account_product, opts)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->patch_account_product: #{e}"
end

Using the patch_account_product_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> patch_account_product_with_http_info(product_id, patch_account_product, opts)

begin
  # Patch account product
  data, status_code, headers = api_instance.patch_account_product_with_http_info(product_id, patch_account_product, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountProduct>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->patch_account_product_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
product_id	String	Account Product ID
patch_account_product	PatchAccountProduct	Account product fields to be patched
idempotency_key	String	An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.	[optional]

Return type

AccountProduct

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

update_account

update_account(account_id, update_account)

Update account

Deprecated. Please use PATCH /v0/accounts. This route only supports types CHECKING and SAVING. Update account Shadow mode required fields: - account_number - status Lead mode required fields: - All fields are required. Please note: - access_status needs to be in ACTIVE. - PUT request cannot change access_status.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
update_account = SyncteraRubySdk::UpdateAccount.new # UpdateAccount | Account to update

begin
  # Update account
  result = api_instance.update_account(account_id, update_account)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account: #{e}"
end

Using the update_account_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_account_with_http_info(account_id, update_account)

begin
  # Update account
  data, status_code, headers = api_instance.update_account_with_http_info(account_id, update_account)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountGenericResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
update_account	UpdateAccount	Account to update

Return type

AccountGenericResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

update_account_relationship

update_account_relationship(account_id, relationship_id, relationship)

Update account relationship

Update account relationship. Only relationship_type can be updated. customer_id should not be modified.

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
account_id = '57826c51-e4ff-4e57-9558-08cab6b963c7' # String | Unique identifier for the account.
relationship_id = '1a582c51-e4ff-4e57-9558-08cab6b963aa' # String | Relationship ID of the account associate with the account entity
relationship = SyncteraRubySdk::Relationship.new({relationship_type: SyncteraRubySdk::AccountRelationshipType::PRIMARY_ACCOUNT_HOLDER}) # Relationship | Account relationship to be updated

begin
  # Update account relationship
  result = api_instance.update_account_relationship(account_id, relationship_id, relationship)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account_relationship: #{e}"
end

Using the update_account_relationship_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_account_relationship_with_http_info(account_id, relationship_id, relationship)

begin
  # Update account relationship
  data, status_code, headers = api_instance.update_account_relationship_with_http_info(account_id, relationship_id, relationship)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RelationshipResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account_relationship_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
account_id	String	Unique identifier for the account.
relationship_id	String	Relationship ID of the account associate with the account entity
relationship	Relationship	Account relationship to be updated

Return type

RelationshipResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json, application/problem+json

update_account_template

update_account_template(template_id, account_template)

Update account template

Update account template

Examples

require 'time'
require 'synctera_ruby_sdk'
# setup authorization
SyncteraRubySdk.configure do |config|
  # Configure Bearer authorization (api_key): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = SyncteraRubySdk::AccountsApi.new
template_id = 'a8943c51-e4ff-4e57-9558-08cab6b963c0' # String | Account Template ID
account_template = SyncteraRubySdk::AccountTemplate.new({is_enabled: false, name: 'name_example', template: SyncteraRubySdk::TemplateFieldsChargeSecured.new({account_type: SyncteraRubySdk::AccountType::SAVING, bank_country: 'US', currency: 'USD', minimum_payment: SyncteraRubySdk::MinimumPaymentTypeFull.new({type: SyncteraRubySdk::MinimumPaymentType::RATE_OR_AMOUNT})})}) # AccountTemplate | Account template to update

begin
  # Update account template
  result = api_instance.update_account_template(template_id, account_template)
  p result
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account_template: #{e}"
end

Using the update_account_template_with_http_info variant

This returns an Array which contains the response data, status code and headers.

, Integer, Hash)> update_account_template_with_http_info(template_id, account_template)

begin
  # Update account template
  data, status_code, headers = api_instance.update_account_template_with_http_info(template_id, account_template)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <AccountTemplateResponse>
rescue SyncteraRubySdk::ApiError => e
  puts "Error when calling AccountsApi->update_account_template_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
template_id	String	Account Template ID
account_template	AccountTemplate	Account template to update

Return type

AccountTemplateResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json