Initiate account closure
Initiates an account closure. It immediately changes the account status to IN_CLOSING. Once the account status is IN_CLOSING, the account can no longer be used to create new transactions.
Path parameters
Unique identifier for the account.
Headers
An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.
Request body
internal/external/customer account ID, depending on payment_method
Payment method for the final payment if the account being closed carries a balance.
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.
Additional details about the reason for closing the account
Example request
{
"reason": "BANK_REQUEST_REGULATORY_REASONS"
}Response
Account to close
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.
Timestamp of the last modification of the access_status. RFC3339 format.
Account number
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.
Purpose of the account
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.
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.
The application ID for this account.
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.
Identifier of the bank side account that this account is a part of
Bank routing number
A list of the business IDs of the account holders.
The account close date. This is the bank's posting date when the account resource's status was changed to CLOSED or CHARGED_OFF.
Account creation timestamp in RFC3339 format
The credit limit for this line of credit account in cents. Minimum is 0.
Account currency or account settlement currency. ISO 4217 alphabetic currency code. Default USD
A list of the customer IDs of the account holders.
Customer type
The number of days since the account went past due on their minimum payments.
Exchange rate type
A list of fee account products that the current account associates with.
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.
The category of the general ledger account. This read-only property is determined by the general_ledger_type.
The type of general ledger account. This is required when creating a general ledger account.
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.
International bank account number
Account ID
The account in-closing date. This is the bank's posting date when the account resource's status was changed to IN_CLOSING.
An interest account product that the current account associates with.
Account is investment (variable balance) account or a multi-balance account pool. Default false
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.
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.
A flag to indicate whether ACH transactions are enabled.
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.
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.
A flag to indicate whether card transactions are enabled.
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.
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.
A flag to indicate whether cash transactions are enabled.
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.
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.
A flag to indicate whether check transactions are enabled.
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.
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.
A flag to indicate whether EFT Canada transactions are enabled.
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.
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.
A flag to indicate whether external card transactions are enabled.
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.
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.
A flag to indicate whether FedNow transactions are enabled.
A flag to indicate whether P2P transactions are enabled.
A flag to indicate whether SAR generation is enabled.
A flag to indicate whether this account is being used as security for another account.
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.
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.
A flag to indicate whether Synctera Pay transactions are enabled.
A flag to indicate whether auto pay feature is enabled.
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.
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.
A flag to indicate whether wire transactions are enabled.
Timestamp of the last account modification in RFC3339 format
User provided account metadata
User provided account nickname
The account open date. This is the bank's posting date when the account resource was created.
This field is unused and will be removed in a future API version.
A list of reward account products that the current account associates with.
List of spend control IDs to control spending for the account
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
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
Example response
{
"account_closure": {
"reason": "BANK_REQUEST_REGULATORY_REASONS",
"validation_responses": [
{
"message": "Cards decoupled from account",
"name": "cards",
"validated": true
}
]
},
"account_number_masked": "123*****6789",
"account_purpose": "This account for the account holder's salary deposit.",
"auto_payment_period": 20,
"balances": [
{
"balance": 2399
}
],
"billing_period": {
"start_date": "2022-01-01T00:00:00Z"
},
"credit_limit": 2500,
"currency": "USD",
"exchange_rate_type": "M, INTERBANK, CUST",
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"tenant": "abcdef_ghijkl",
"vendor_info": {
"vendor_data": {
"loanpro": {
"cash_advance_bucket_id": 67890,
"loc_id": 12345,
"loc_product_id": 67890,
"purchases_bucket_id": 12345,
"tenant_id": "1",
"daily_archive": {
"archive_date": "2024-01-15",
"bucket_interest_rates": [
{
"bucket_display_name": "Purchases",
"bucket_label": "purchase",
"rate_bps": 1800
}
]
}
}
},
"vendor_type": "LOANPRO"
}
}