--- title: "Create an account" method: POST path: "/accounts" tags: ["Accounts"] --- # Create an account `POST /accounts` 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. Account holder `verification_status` must be `ACCEPTED` to create an account. Required fields: - relationships ## Headers - `Idempotency-Key` string ## Request body - union - object — Account representing either a checking or saving account. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `balance_ceiling` BalanceCeiling - `balance` integer, required — Maximum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling - `overflow_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling This attribute is a deprecated alias for linked_account_id. - `balance_floor` BalanceFloor - `balance` integer, required — Minimum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor - `overdraft_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor This attribute is a deprecated alias for linked_account_id. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `interest_product_id` string, uuid — An interest account product that the current account associates with. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `overdraft_limit` integer — This field is unused and will be removed in a future API version. - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `spending_limits` SpendingLimits — Account spending limits is unused and has been deprecated. Instead use the spend controls API. - `day` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `description` string — User provided description on the spending limits - `lifetime` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `month` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `transaction` object — Individual transaction limit - `amount` integer — Maximum amount allowed. Unit in cents. - `week` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_external_card_credit_enabled` boolean — A flag to indicate whether external card credits are enabled. Both is_external_card_enabled and is_external_card_credit_enabled must be true for an external card credit to be allowed. - `is_external_card_debit_enabled` boolean — A flag to indicate whether external card debits are enabled. Both is_external_card_enabled and is_external_card_debit_enabled must be true for an external card debit to be allowed. - `is_external_card_enabled` boolean — A flag to indicate whether external card transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a secured revolving credit account. - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `security` Security - `linked_account_id` string, uuid, required — ID of linked backing account for use as a security, e.g. for use in a Smart Charge Card offering. Must be of type CHECKING or SAVING. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `vendor_info` VendorInfo — Vendor information for external account management systems - `vendor_data` VendorData, required — Vendor-specific data - `loanpro` LoanproVendorData - `cash_advance_bucket_id` integer — LoanPro cash advance bucket ID - `loc_id` integer — LoanPro line of credit account ID - `loc_product_id` integer — LoanPro line of credit product ID - `purchases_bucket_id` integer — LoanPro purchases bucket ID - `tenant_id` string — LoanPro tenant ID - `vendor_type` 'LOANPRO', required — The type of vendor managing this account - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a charge unsecured account. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `balance_ceiling` BalanceCeiling - `balance` integer, required — Maximum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling - `overflow_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling This attribute is a deprecated alias for linked_account_id. - `balance_floor` BalanceFloor - `balance` integer, required — Minimum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor - `overdraft_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor This attribute is a deprecated alias for linked_account_id. - `credit_limit` integer — The credit limit for this charge unsecured account in cents. Minimum is 0. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `minimum_payment` MinimumPaymentFull — The scheme for calculating the minimum payment due for outstanding balances in a billing period. - `type` 'FULL' | 'RATE_OR_AMOUNT', required — * RATE_OR_AMOUNT: Describes a minimum payment scheme where the amount calculated is either a portion of the balance due, or a fixed, minimum amount, whichever is greater. For example, if set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance, or $30, whichever is greatest. However, the minimum payment will never exceed the statement balance. * FULL: Describes a minimum payment scheme where the amount calculated is the entire account balance at the end of the statement period. Note that the choice of minimum payment type is constrained by the account type. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a general ledger (vs a customer account). In production, general ledger accounts can only be created or updated by a Synctera administrator. General ledger accounts are in Alpha status, and cannot yet be created. We may make breaking changes. - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `general_ledger_type` 'ACH_SETTLEMENT' | 'ACH_SUSPENSE' | 'ALLOCATED_SUSPENSE' | 'BANK_DRAFT' | 'BILLING_EXPENSE' | 'BILLING_REVENUE' | 'CARD_AFT_PREFUNDING' | 'CARD_OCT_SETTLEMENT' | 'CARD_SETTLEMENT' | 'CASH_SETTLEMENT' | 'CASH_SUSPENSE' | 'CHECK_SETTLEMENT' | 'DISPUTE_WRITE_OFF_PNL' | 'EFT_CA_SETTLEMENT' | 'EFT_CA_SUSPENSE' | 'EXTERNAL_CARD_AFT_SETTLEMENT' | 'EXTERNAL_CARD_OCT_SETTLEMENT' | 'FEDNOW_SETTLEMENT' | 'FEES' | 'FRAUD_LOSSES' | 'FUNDING_ACCOUNTS' | 'GENERAL_PNL' | 'INTEREST_PAYOUT' | 'INTERNATIONAL_WIRE_SETTLEMENT' | 'IN_STORE_CASH_SETTLEMENT' | 'LOC_INTEREST_INCOME' | 'LOC_INVESTOR_PORTFOLIO' | 'LOC_REPURCHASE' | 'MONEY_IN_AND_OUT' | 'NEGATIVE_BALANCE' | 'NETWORK_ADJUSTMENT' | 'NETWORK_CHARGEBACK' | 'NEW_FUNDING_ACCOUNT' | 'PROVISIONAL_CREDIT_PNL' | 'RESERVE' | 'REWARDS' | 'SC_INVESTOR_PORTFOLIO' | 'SC_REPURCHASE' | 'SYNCTERA_PAY_SUSPENSE' | 'USC_INTEREST_INCOME' | 'USC_INVESTOR_PORTFOLIO' | 'USC_REPURCHASE' | 'WIRE_SETTLEMENT' | 'WIRE_SUSPENSE' | 'WRITE_OFF' — The type of general ledger account. This is required when creating a general ledger account. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a credit card account. - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `vendor_info` VendorInfo — Vendor information for external account management systems - `vendor_data` VendorData, required — Vendor-specific data - `loanpro` LoanproVendorData - `cash_advance_bucket_id` integer — LoanPro cash advance bucket ID - `loc_id` integer — LoanPro line of credit account ID - `loc_product_id` integer — LoanPro line of credit product ID - `purchases_bucket_id` integer — LoanPro purchases bucket ID - `tenant_id` string — LoanPro tenant ID - `vendor_type` 'LOANPRO', required — The type of vendor managing this account - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a secured charge account, e.g. for use in a Smart Charge Card offering. - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `auto_payment_period` integer — The number of days past the billing period to initiate an auto payment. Only applicable for accounts with type `CHARGE_SECURED`, where the account holder has opted in for auto payment functionality. This value must be lower than or equal to the `grace_period` setting on the account. If this value is 0, the auto payment will happen on the same day as the statement is generated. Auto payment only occurs if regular payments are not received on time. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `is_system_auto_pay_enabled` boolean — A flag to indicate whether auto payments are enabled. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `security` Security - `linked_account_id` string, uuid, required — ID of linked backing account for use as a security, e.g. for use in a Smart Charge Card offering. Must be of type CHECKING or SAVING. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing an unsecured revolving credit account. - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `balance_ceiling` BalanceCeiling - `balance` integer, required — Maximum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling - `overflow_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling This attribute is a deprecated alias for linked_account_id. - `balance_floor` BalanceFloor - `balance` integer, required — Minimum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor - `overdraft_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor This attribute is a deprecated alias for linked_account_id. - `credit_limit` integer — The credit limit for this revolving credit unsecured account in cents. Minimum is 0. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `vendor_info` VendorInfo — Vendor information for external account management systems - `vendor_data` VendorData, required — Vendor-specific data - `loanpro` LoanproVendorData - `cash_advance_bucket_id` integer — LoanPro cash advance bucket ID - `loc_id` integer — LoanPro line of credit account ID - `loc_product_id` integer — LoanPro line of credit product ID - `purchases_bucket_id` integer — LoanPro purchases bucket ID - `tenant_id` string — LoanPro tenant ID - `vendor_type` 'LOANPRO', required — The type of vendor managing this account - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. - object — Account representing a line of credit account. - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_routing` string — Bank routing number - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `exchange_rate_type` string — Exchange rate type - `iban` string — International bank account number - `id` string, uuid — Account ID - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `nickname` string — User provided account nickname - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `swift_code` string — SWIFT code - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `credit_limit` integer — The credit limit for this line of credit account in cents. Minimum is 0. - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `grace_period` integer — The number of days past the billing period to allow for payment before it is considered due. This directly determines the due date for a payment. - `interest_product_id` string, uuid — An interest account product that the current account associates with. The account product must have its calculation_method set to COMPOUNDED_DAILY. - `minimum_payment` MinimumPaymentPartial — The scheme for calculating the minimum payment due for outstanding balances in a billing period. - `min_amount` integer, required — The minimum amount to charge as a minimum payment, in cents. For example, to set the minimum to $30, set this value to 3000. Note: despite setting this value, the minimum payment will never be greater than the statement balance. - `rate` integer, required — The percentage of the balance to use, in basis points. For example, to set 12.5% of the balance, set this value to 1250. - `type` 'FULL' | 'RATE_OR_AMOUNT', required — * RATE_OR_AMOUNT: Describes a minimum payment scheme where the amount calculated is either a portion of the balance due, or a fixed, minimum amount, whichever is greater. For example, if set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance, or $30, whichever is greatest. However, the minimum payment will never exceed the statement balance. * FULL: Describes a minimum payment scheme where the amount calculated is the entire account balance at the end of the statement period. Note that the choice of minimum payment type is constrained by the account type. - `note` string — Add an optional note when creating or updating an account. A note is required when updating the status to or from SUSPENDED - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `manual_account_number` string — Manually supplied account number. Providing your own account number must be agreed upon by the bank and Synctera ahead of time. Must be exactly 12 digits and must start with the partner's bank_branch_id. - `relationships` AccountRelationship[] — List of the relationship for this account to the parties, Primary account holders are inferred for accounts of type general ledger and should not be provided in this request. - `business_id` string, uuid — Business associated with the current account. One of business_id or customer_id must be specified. - `created_at` string, date-time — Date and time when this association was created. - `customer_id` string, uuid — Personal customer associated with the current account. One of customer_id or business_id must be specified. - `deleted_at` string, date-time — Date and time when this association was deleted. - `id` string, uuid — ID of account relationship - `ownership_percentage` number, double — The ownership percentage of the related party. - `person_id` string, uuid — Person associated with the current account. This attribute is deprecated and will be removed in a future API version. Use customer_id instead. - `relationship_type` 'ACCOUNT_HOLDER' | 'AUTHORIZED_SIGNER' | 'AUTHORIZED_USER' | 'BENEFICIARY' | 'JOINT_ACCOUNT_HOLDER' | 'PRIMARY_ACCOUNT_HOLDER', required — Relationship type - `updated_at` string, date-time — Date and time when this association was last updated. ## Response `201` Created account - AccountGenericResponse - `access_status` 'ACTIVE' | 'FROZEN' — Represents whether a customer has frozen their account. `FROZEN` is a customer-initiated state meaning that the account will reject all debits, typically used for a lost or stolen card. - `access_status_last_updated_time` string, date-time — Timestamp of the last modification of the access_status. RFC3339 format. - `account_closure` AccountClosureResponse — Account closing details when attempting to close an account and status is being changed to `IN_CLOSING`. - `cases` Case[] — Cases associated with the account closure - `case_id` string, required — Case ID - `case_reason` string, required — Case Reason - `destination_id` string, uuid, nullable, required — internal/external/customer account ID, depending on payment_method - `payment_method` 'ACH' | 'BANK_DRAFT' | 'INTERNAL_TRANSFER_TO_CUSTOMER_ACCOUNT' | 'INTERNAL_TRANSFER_TO_INTERNAL_ACCOUNT', nullable, required — Payment method for the final payment if the account being closed carries a balance. - `reason` 'BANK_REQUEST_CHARGE_OFF' | 'BANK_REQUEST_FRAUD' | 'BANK_REQUEST_INACTIVITY' | 'BANK_REQUEST_REDEEMED_OR_REINSTATED_REPOSSESSION' | 'BANK_REQUEST_REGULATORY_REASONS' | 'BANK_REQUEST_WRITE_OFF' | 'CUSTOMER_REQUEST_CREDIT_CARD_LOST_OR_STOLEN' | 'CUSTOMER_REQUEST_REFINANCE' | 'CUSTOMER_REQUEST_TRANSFER' | 'CUSTOMER_REQUEST_VOLUNTARILY_SURRENDERED' | 'PROGRAM_SHUT_DOWN_BANK' | 'PROGRAM_SHUT_DOWN_FINTECH', required — The enumerated reason for closing the account. This is a required field when closing an account; the given value will be validated against the caller's permissions. * `BANK_REQUEST_CHARGE_OFF` – A charge-off is when a creditor declares an uncollected debt a loss and removes it from its balance sheet. The account will be closed to new charges and may be sent to a collection agency. * `BANK_REQUEST_WRITE_OFF` - A write-off is when a bank declares an uncollected debt a loss and removes it from its balance sheet. The account will be closed to new charges. - `reason_details` string, required — Additional details about the reason for closing the account - `validation_responses` AccountClosureValidationResponse[] - `details` object, required - `message` string, required — Validation message - `name` string, required — Name - `validated` boolean, required — Validation result - `account_number` string — Account number - `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. - `account_program_id` string, uuid - `account_purpose` string — Purpose of the account - `account_template_id` string, uuid — The account template used to create this account (if any). On creation, if not specified: * `account_type` is *required*. * If there is a single account template of the correct type, that account template is automatically used. * Otherwise, the request is an error. - `account_type` 'CHARGE_SECURED' | 'CHARGE_UNSECURED' | 'CHECKING' | 'CREDIT_CARD' | 'GENERAL_LEDGER' | 'LINE_OF_CREDIT' | 'PREPAID' | 'REVOLVING_CREDIT_SECURED' | 'REVOLVING_CREDIT_UNSECURED' | 'SAVING' — The type of the account. In lead mode, this always takes the value of the template. If not specified in shadow mode, CHECKING will be assumed. Below mentioned are the account types: * SAVING: Savings account * CHECKING: Checking account * PREPAID: Prepaid account * LINE_OF_CREDIT: Line of Credit account * CREDIT_CARD: Credit Card account * CHARGE_SECURED: Secured Charge account, e.g. for use in a Smart Charge Card offering * CHARGE_UNSECURED: (alpha) Unsecured Charge account * REVOLVING_CREDIT_SECURED: Secured Revolving Credit account * REVOLVING_CREDIT_UNSECURED: Unsecured Revolving Credit account * GENERAL_LEDGER: General Ledger account (alpha - cannot yet be created). In production, these can only be created or updated by a Synctera administrator. - `application_id` string, uuid — The application ID for this account. - `auto_payment_period` integer — The number of days past the billing period to initiate an auto payment. Only applicable for accounts with type `CHARGE_SECURED`, where the account holder has opted in for auto payment functionality. This value must be lower than or equal to the `grace_period` setting on the account. If this value is 0, the auto payment will happen on the same day as the statement is generated. Auto payment only occurs if regular payments are not received on time. - `balance_ceiling` BalanceCeiling - `balance` integer, required — Maximum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling - `overflow_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling This attribute is a deprecated alias for linked_account_id. - `balance_floor` BalanceFloor - `balance` integer, required — Minimum balance in the account's currency. Unit in cents. - `linked_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor - `overdraft_account_id` string, uuid — ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor This attribute is a deprecated alias for linked_account_id. - `balances` Balance[] — A list of balances for account based on different type - `balance` integer, required — balance in ISO 4217 minor currency units. Unit in cents. - `type` 'ACCOUNT_BALANCE' | 'ACCRUED_INTEREST_MTD' | 'AVAILABLE_BALANCE' | 'PAYMENTS_RECEIVED_MTD', required — * `ACCOUNT_BALANCE`: The posted balance of the account. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the sum of credits minus debits for all posted transactions. For a lending account, e.g. `CHARGE_SECURED` or `LINE_OF_CREDIT`, this is a measure of the sum of debits minus credits for all posted transactions. This value can be negative. * `AVAILABLE_BALANCE`: The available balance of the account, which is the amount available to spend, or the spending power. For a banking account, e.g. `CHECKING` or `SAVING`, this is a measure of the account balance minus any pending debits. For an unsecured lending account, e.g. `CHARGE_UNSECURED` or `LINE_OF_CREDIT`, this is a measure of available credit, which is its credit limit minus the account balance, minus any pending debits. For a `CHARGE_SECURED` account, it equals the `AVAILABLE_BALANCE` of the linked security account. This value will never be negative. * `ACCRUED_INTEREST_MTD`: The amount of accrued but unposted interest. This value may fluctuate, as new transactions can affect interest amounts. Treat accrued interest as pending for the billing month until it is posted at the end of the billing period. * `PAYMENTS_RECEIVED_MTD`: The amount of payment received to date for the billing month. - `bank_account_id` string — Identifier of the bank side account that this account is a part of - `bank_routing` string — Bank routing number - `billing_period` BillingPeriod — The scheme for determining an account's billing period. - `frequency` 'ANNUALLY' | 'BI_WEEKLY' | 'DAILY' | 'MONTHLY' | 'SEMI_MONTHLY' | 'WEEKLY', required — The frequency of billing cycles. Along with the start date, this will determine the start and end of each cycle. - `start_date` string, date-time, required — The first day of the first billing cycle for this account. For a monthly billing cycle, this would determine the day of the month each billing cycle will start on. Note that, although this is returned as a UTC timestamp, the date always corresponds to the bank's calendar, and therefore the time and timezone should be ignored. - `business_ids` string[] — A list of the business IDs of the account holders. - `close_date` string, date — The account close date. This is the bank's posting date when the account resource's status was changed to CLOSED or CHARGED_OFF. - `creation_time` string, date-time — Account creation timestamp in RFC3339 format - `credit_limit` integer — The credit limit for this line of credit account in cents. Minimum is 0. - `currency` string — Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD - `customer_ids` string[] — A list of the customer IDs of the account holders. - `customer_type` 'BUSINESS' | 'PERSONAL' — Customer type - `days_past_due` integer — The number of days since the account went past due on their minimum payments. - `exchange_rate_type` string — Exchange rate type - `fee_product_ids` string[], nullable — A list of fee account products that the current account associates with. - `funds_ownership` 'BANK' | 'FINTECH' | 'PLATFORM' — An account's funds ownership indicates which organization owns the funds in the account. For example, some GENERAL_LEDGER accounts have funds owned by the bank, even though the account is in the fintech tenant. Fintechs are not able to perform money movement on accounts where the bank or platform owns the funds. This read-only property is determined by the account_type and general_ledger_type. - `general_ledger_category` 'CORE' | 'PROFIT_AND_LOSS' | 'RESERVE' | 'SETTLEMENT' | 'SUSPENSE' | 'TREASURY' — The category of the general ledger account. This read-only property is determined by the general_ledger_type. - `general_ledger_type` 'ACH_SETTLEMENT' | 'ACH_SUSPENSE' | 'ALLOCATED_SUSPENSE' | 'BANK_DRAFT' | 'BILLING_EXPENSE' | 'BILLING_REVENUE' | 'CARD_AFT_PREFUNDING' | 'CARD_OCT_SETTLEMENT' | 'CARD_SETTLEMENT' | 'CASH_SETTLEMENT' | 'CASH_SUSPENSE' | 'CHECK_SETTLEMENT' | 'DISPUTE_WRITE_OFF_PNL' | 'EFT_CA_SETTLEMENT' | 'EFT_CA_SUSPENSE' | 'EXTERNAL_CARD_AFT_SETTLEMENT' | 'EXTERNAL_CARD_OCT_SETTLEMENT' | 'FEDNOW_SETTLEMENT' | 'FEES' | 'FRAUD_LOSSES' | 'FUNDING_ACCOUNTS' | 'GENERAL_PNL' | 'INTEREST_PAYOUT' | 'INTERNATIONAL_WIRE_SETTLEMENT' | 'IN_STORE_CASH_SETTLEMENT' | 'LOC_INTEREST_INCOME' | 'LOC_INVESTOR_PORTFOLIO' | 'LOC_REPURCHASE' | 'MONEY_IN_AND_OUT' | 'NEGATIVE_BALANCE' | 'NETWORK_ADJUSTMENT' | 'NETWORK_CHARGEBACK' | 'NEW_FUNDING_ACCOUNT' | 'PROVISIONAL_CREDIT_PNL' | 'RESERVE' | 'REWARDS' | 'SC_INVESTOR_PORTFOLIO' | 'SC_REPURCHASE' | 'SYNCTERA_PAY_SUSPENSE' | 'USC_INTEREST_INCOME' | 'USC_INVESTOR_PORTFOLIO' | 'USC_REPURCHASE' | 'WIRE_SETTLEMENT' | 'WIRE_SUSPENSE' | 'WRITE_OFF' — The type of general ledger account. This is required when creating a general ledger account. - `grace_period` integer — The number of days past the billing period to allow for payment before it is considered due. This directly determines the due date for a payment. - `iban` string — International bank account number - `id` string, uuid — Account ID - `in_closing_date` string, date — The account in-closing date. This is the bank's posting date when the account resource's status was changed to IN_CLOSING. - `interest_product_id` string, uuid — An interest account product that the current account associates with. - `is_account_pool` boolean — Account is investment (variable balance) account or a multi-balance account pool. Default false - `is_ach_credit_enabled` boolean — A flag to indicate whether ACH credits are enabled. Both is_ach_enabled and is_ach_credit_enabled must be true for an ACH credit to be allowed. - `is_ach_debit_enabled` boolean — A flag to indicate whether ACH debits are enabled. Both is_ach_enabled and is_ach_debit_enabled must be true for an ACH debit to be allowed. - `is_ach_enabled` boolean — A flag to indicate whether ACH transactions are enabled. - `is_card_credit_enabled` boolean — A flag to indicate whether card credits are enabled. Both is_card_enabled and is_card_credit_enabled must be true for a card credit to be allowed. - `is_card_debit_enabled` boolean — A flag to indicate whether card debits are enabled. Both is_card_enabled and is_card_debit_enabled must be true for a card debit to be allowed. - `is_card_enabled` boolean — A flag to indicate whether card transactions are enabled. - `is_cash_credit_enabled` boolean — A flag to indicate whether cash credits are enabled. Both is_cash_enabled and is_cash_credit_enabled must be true for a cash credit to be allowed. - `is_cash_debit_enabled` boolean — A flag to indicate whether cash debits are enabled. Both is_cash_enabled and is_cash_debit_enabled must be true for a cash debit to be allowed. - `is_cash_enabled` boolean — A flag to indicate whether cash transactions are enabled. - `is_check_credit_enabled` boolean — A flag to indicate whether check credits are enabled. Both is_check_enabled and is_check_credit_enabled must be true for a check credit to be allowed. - `is_check_debit_enabled` boolean — A flag to indicate whether check debits are enabled. Both is_check_enabled and is_check_debit_enabled must be true for a check debit to be allowed. - `is_check_enabled` boolean — A flag to indicate whether check transactions are enabled. - `is_eft_ca_credit_enabled` boolean — A flag to indicate whether EFT Canada credits are enabled. Both is_eft_ca_enabled and is_eft_ca_credit_enabled must be true for an EFT Canada credit to be allowed. - `is_eft_ca_debit_enabled` boolean — A flag to indicate whether EFT Canada debits are enabled. Both is_eft_ca_enabled and is_eft_ca_debit_enabled must be true for an EFT Canada debit to be allowed. - `is_eft_ca_enabled` boolean — A flag to indicate whether EFT Canada transactions are enabled. - `is_external_card_credit_enabled` boolean — A flag to indicate whether external card credits are enabled. Both is_external_card_enabled and is_external_card_credit_enabled must be true for an external card credit to be allowed. - `is_external_card_debit_enabled` boolean — A flag to indicate whether external card debits are enabled. Both is_external_card_enabled and is_external_card_debit_enabled must be true for an external card debit to be allowed. - `is_external_card_enabled` boolean — A flag to indicate whether external card transactions are enabled. - `is_fednow_credit_enabled` boolean — A flag to indicate whether FedNow credits are enabled. Both is_fednow_enabled and is_fednow_credit_enabled must be true for a FedNow credit to be allowed. - `is_fednow_debit_enabled` boolean — A flag to indicate whether FedNow debits are enabled. Both is_fednow_enabled and is_fednow_debit_enabled must be true for a FedNow debit to be allowed. - `is_fednow_enabled` boolean — A flag to indicate whether FedNow transactions are enabled. - `is_p2p_enabled` boolean — A flag to indicate whether P2P transactions are enabled. - `is_sar_enabled` boolean — A flag to indicate whether SAR generation is enabled. - `is_security` boolean — A flag to indicate whether this account is being used as security for another account. - `is_synctera_pay_credit_enabled` boolean — A flag to indicate whether Synctera Pay credits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_credit_enabled must be true for a Synctera Pay credit to be allowed. - `is_synctera_pay_debit_enabled` boolean — A flag to indicate whether Synctera Pay debits are enabled. Both is_synctera_pay_enabled and is_synctera_pay_debit_enabled must be true for a Synctera Pay debit to be allowed. - `is_synctera_pay_enabled` boolean — A flag to indicate whether Synctera Pay transactions are enabled. - `is_system_auto_pay_enabled` boolean — A flag to indicate whether auto pay feature is enabled. - `is_wire_credit_enabled` boolean — A flag to indicate whether wire credits are enabled. Both is_wire_enabled and is_wire_credit_enabled must be true for a wire credit to be allowed. - `is_wire_debit_enabled` boolean — A flag to indicate whether wire debits are enabled. Both is_wire_enabled and is_wire_debit_enabled must be true for a wire debit to be allowed. - `is_wire_enabled` boolean — A flag to indicate whether wire transactions are enabled. - `last_updated_time` string, date-time — Timestamp of the last account modification in RFC3339 format - `metadata` object — User provided account metadata - `minimum_payment` union — The scheme for calculating the minimum payment due for outstanding balances in a billing period. - object - `min_amount` integer, required — The minimum amount to charge as a minimum payment, in cents. For example, to set the minimum to $30, set this value to 3000. Note: despite setting this value, the minimum payment will never be greater than the statement balance. - `rate` integer, required — The percentage of the balance to use, in basis points. For example, to set 12.5% of the balance, set this value to 1250. - `type` 'FULL' | 'RATE_OR_AMOUNT', required — * RATE_OR_AMOUNT: Describes a minimum payment scheme where the amount calculated is either a portion of the balance due, or a fixed, minimum amount, whichever is greater. For example, if set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance, or $30, whichever is greatest. However, the minimum payment will never exceed the statement balance. * FULL: Describes a minimum payment scheme where the amount calculated is the entire account balance at the end of the statement period. Note that the choice of minimum payment type is constrained by the account type. - object - `type` 'FULL' | 'RATE_OR_AMOUNT', required — * RATE_OR_AMOUNT: Describes a minimum payment scheme where the amount calculated is either a portion of the balance due, or a fixed, minimum amount, whichever is greater. For example, if set to 1.00% and $30, the minimum payment will be calculated as 1.00% of the balance, or $30, whichever is greatest. However, the minimum payment will never exceed the statement balance. * FULL: Describes a minimum payment scheme where the amount calculated is the entire account balance at the end of the statement period. Note that the choice of minimum payment type is constrained by the account type. - `nickname` string — User provided account nickname - `open_date` string, date — The account open date. This is the bank's posting date when the account resource was created. - `overdraft_limit` integer — This field is unused and will be removed in a future API version. - `restrictions` AccountRestrictions — Conditions that restrict the use of the account. - `is_account_out_of_area` boolean — A flag to indicate whether any of the account holders of the account are out of the supported countries. Can only be set by the Synctera platform. - `is_delinquent` boolean — A flag to indicate whether a credit account is greater than 30 days past due on minimum payments. Delinquent accounts will be unable to spend until overdue amount is paid. Can only be set by the Synctera platform. - `is_past_due` boolean — A flag to indicate whether a credit account is past due on minimum payments. Can only be set by the Synctera platform. - `is_revoked` boolean — A flag to indicates whether a credit account has been revoked (greater than 90 days past due). Revoked accounts will be unable to spend and no longer accrue interest. Can only be set by the Synctera platform. - `reward_product_ids` string[], nullable — A list of reward account products that the current account associates with. - `security` Security - `linked_account_id` string, uuid, required — ID of linked backing account for use as a security, e.g. for use in a Smart Charge Card offering. Must be of type CHECKING or SAVING. - `spend_control_ids` string[] — List of spend control IDs to control spending for the account - `spending_limits` SpendingLimits — Account spending limits is unused and has been deprecated. Instead use the spend controls API. - `day` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `description` string — User provided description on the spending limits - `lifetime` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `month` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `transaction` object — Individual transaction limit - `amount` integer — Maximum amount allowed. Unit in cents. - `week` SpendingLimitWithTime — Limit over a specific time period. - `amount` integer — Maximum amount allowed within the time range. Unit in cents. - `transactions` integer — Maximum number of transactions allowed within the time range - `status` 'ACCOUNT_NEVER_ACTIVE' | 'ACCOUNT_NOT_DESIRED' | 'ACTIVATED_NOT_DISBURSED' | 'ACTIVE_OR_DISBURSED' | 'APPLICATION_SUBMITTED' | 'AWAITING_FIXING' | 'CHARGED_OFF' | 'CLOSED' | 'DELINQUENT' | 'FAILED_KYC' | 'IN_CLOSING' | 'RESTRICTED' | 'SUSPENDED' — The status of the account. | Status | Description | Transactable | |------|-----------|-----| | ACCOUNT_NEVER_ACTIVE | Account was never activated by the customer | N | | ACCOUNT_NOT_DESIRED | A credit account was created for a customer, but the customer did not accept the account | N | | ACTIVATED_NOT_DISBURSED | A credit account was created for the customer, but the funds have not been paid out or used | N | | ACTIVE_OR_DISBURSED | The account is active and transactable | Y | | APPLICATION_SUBMITTED | Deprecated status | N | | AWAITING_FIXING | Account is awaiting fixing | N | | CHARGED_OFF | The account has been charged off and is closed | N | | CLOSED | Accounts must be zeroed out before being closed. Closed accounts cannot transact | N | | DELINQUENT | Synctera will update a credit account to delinquent if the customer has not paid within their expected billing cycle | N | | FAILED_KYC | We were unable to verify the identity of the account holder: they have not passed know-your-customer (KYC) checks | N | | IN_CLOSING | The account is in the process of being closed. An account with the IN_CLOSING status may only be updated to CLOSED. Updates to other statuses are prohibited. | N | | RESTRICTED | Synctera will update accounts to restricted of the account holder has not successfully passed KYC | N | | SUSPENDED | Account has been suspected of fraudulent activity and is blocked from further transactions | N | - `stop_payments` StopPayment[] - `dispute_id` string, uuid — ID of the dispute that created the stop payment - `expires_on` string, date-time — The date when this stop payment is no longer valid. This is only for business accounts. - `originator_name` string, required — Name of the originator - `stop_payment_id` string, uuid, required - `transaction_id` string, uuid — If this stop payment was created from a disputed transaction, transaction_id references the posted transaction. - `swift_code` string — SWIFT code - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. - `vendor_info` VendorInfoResponse — Vendor information for external account management systems - `vendor_data` VendorDataResponse, required — Vendor-specific data - `loanpro` LoanproVendorDataResponse — LoanPro-specific vendor data for account - `cash_advance_bucket_id` integer, required — LoanPro cash advance bucket ID - `loc_id` integer, required — LoanPro line of credit account ID - `loc_product_id` integer, required — LoanPro line of credit product ID - `purchases_bucket_id` integer, required — LoanPro purchases bucket ID - `tenant_id` string, required — LoanPro tenant ID - `daily_archive` LoanproDailyArchive — Daily snapshot data from LoanPro (enriched at read time) - `archive_date` string, date — Date of this snapshot - `bucket_interest_rates` LoanproBucketInterestRate[] — Interest rates for each transaction bucket - `bucket_display_name` string — Human-readable display name for the bucket - `bucket_label` string — Bucket label identifier. Common values include purchase, cash_advances, and balance_transfer, but custom bucket labels may be configured in LoanPro. - `rate_bps` integer — Interest rate in basis points (1800 = 18.00% APR) - `vendor_type` 'LOANPRO', required — The type of vendor managing this account ## Other responses - `401` — Unauthorized - `409` — Resource already exists error - `422` — Unprocessable entity request response --- [API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/versions/b0d812e6cdd0/schema)