Account.md

Synctera::Account

Properties

Name	Type	Description	Notes
balance_ceiling	BalanceCeiling		[optional]
balance_floor	BalanceFloor		[optional]
fee_product_ids	Array<String>	A list of fee account products that the current account associates with.	[optional]
interest_product_id	String	An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_DAILY.	[optional]
note	String	Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED	[optional]
overdraft_limit	Integer	This field is unused and will be removed in a future API version.	[optional]
spend_control_ids	Array<String>	List of spend control IDs to control spending for the account	[optional]
spending_limits	SpendingLimits		[optional]
is_ach_enabled	Boolean	A flag to indicate whether ACH transactions are enabled.	[optional]
is_card_enabled	Boolean	A flag to indicate whether card transactions are enabled.	[optional]
is_eft_ca_enabled	Boolean	A flag to indicate whether EFT Canada transactions are enabled.	[optional]
is_external_card_enabled	Boolean	A flag to indicate whether external card transactions are enabled.	[optional]
is_p2p_enabled	Boolean	A flag to indicate whether P2P transactions are enabled.	[optional]
is_synctera_pay_enabled	Boolean	A flag to indicate whether Synctera Pay transactions are enabled.	[optional]
is_wire_enabled	Boolean	A flag to indicate whether wire transactions are enabled.	[optional]
access_status	AccountAccessStatus		[optional]
account_number	String	Account number	[optional][readonly]
account_number_masked	String	The response will contain the bank fintech ID (3 or 6 digits) plus the last 4 digits, with the digits in between replaced with * characters. Shadow mode account numbers will not be masked.	[optional][readonly]
account_purpose	String	Purpose of the account	[optional]
account_template_id	String	The account template used to create this account (if any).	[optional][readonly]
account_type	AccountType		[optional]
application_id	String	The application ID for this account.	[optional]
balances	Array<Balance>	A list of balances for account based on different type	[optional][readonly]
bank_routing	String	Bank routing number	[optional][readonly]
creation_time	Time	Account creation timestamp in RFC3339 format	[optional][readonly]
currency	String	Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD	[optional]
customer_ids	Array<String>	A list of the customer IDs of the account holders.	[optional][readonly]
customer_type	CustomerType		[optional]
exchange_rate_type	String	Exchange rate type	[optional]
iban	String	International bank account number	[optional]
id	String	Account ID	[optional][readonly]
is_account_pool	Boolean	Account is investment (variable balance) account or a multi-balance account pool. Default false	[optional]
is_sar_enabled	Boolean	A flag to indicate whether SAR generation is enabled.	[optional][readonly]
last_updated_time	Time	Timestamp of the last account modification in RFC3339 format	[optional][readonly]
metadata	Object	User provided account metadata	[optional]
nickname	String	User provided account nickname	[optional]
status	AccountStatus		[optional]
swift_code	String	SWIFT code	[optional]
credit_limit	Integer	The credit limit for this line of credit account in cents. Minimum is 0.	[optional]
minimum_payment	MinimumPaymentPartial		[optional]
general_ledger_type	GeneralLedgerType		[optional]
is_system_auto_pay_enabled	Boolean	A flag to indicate whether auto payments are enabled.	[optional][default to false]
security	Security		[optional]
grace_period	Integer	The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment. The default will be set to 21 days.	[optional]

Example

require 'synctera'

instance = Synctera::Account.new(
  balance_ceiling: null,
  balance_floor: null,
  fee_product_ids: null,
  interest_product_id: null,
  note: null,
  overdraft_limit: null,
  spend_control_ids: null,
  spending_limits: null,
  is_ach_enabled: null,
  is_card_enabled: null,
  is_eft_ca_enabled: null,
  is_external_card_enabled: null,
  is_p2p_enabled: null,
  is_synctera_pay_enabled: null,
  is_wire_enabled: null,
  access_status: null,
  account_number: null,
  account_number_masked: 123*****6789,
  account_purpose: This account for the account holder's salary deposit.,
  account_template_id: null,
  account_type: null,
  application_id: null,
  balances: null,
  bank_routing: null,
  creation_time: null,
  currency: USD,
  customer_ids: null,
  customer_type: null,
  exchange_rate_type: M, INTERBANK, CUST,
  iban: null,
  id: null,
  is_account_pool: null,
  is_sar_enabled: null,
  last_updated_time: null,
  metadata: null,
  nickname: null,
  status: null,
  swift_code: null,
  credit_limit: 2500,
  minimum_payment: null,
  general_ledger_type: null,
  is_system_auto_pay_enabled: null,
  security: null,
  grace_period: 21
)