Synctera API
Customers
Accounts
- GETList accounts
- POSTCreate an account
- GETList account products
- POSTCreate an account product
- PATCHPatch account product
- GETListstoppayment
- GETList account templates
- POSTCreate an account template
- DELDelete account template
- GETGet account template
- PUTUpdate account template
- PATCHPatch account template
- GETGet account
- PATCHPatch account
- PUTUpdate account
- POSTInitiate account closure
- GETList account relationships
- POSTCreate account relationship
- DELDelete account relationship
- GETGet account relationship
- PUTUpdate account relationship
- GET
Cards
Money Movement
Transactions
Platform
Simulations
curl --request PUT \
--url https://api.synctera.com/v2/accounts/templates/{template_id} \
--header 'Content-Type: application/json' \
--data '
{
"is_enabled": true,
"name": "<string>",
"template": {
"account_type": "SAVING",
"bank_country": "US",
"currency": "USD",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_ach_enabled": true,
"is_card_enabled": true,
"is_eft_ca_enabled": true,
"is_external_card_enabled": true,
"is_p2p_enabled": true,
"is_synctera_pay_enabled": true,
"is_wire_enabled": true,
"balance_ceiling": {
"balance": 1,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"balance_floor": {
"balance": 123,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"fee_product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_sar_enabled": false,
"overdraft_limit": 1,
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"spending_limits": {
"day": {
"amount": 1,
"transactions": 1
},
"description": "<string>",
"lifetime": {
"amount": 1,
"transactions": 1
},
"month": {
"amount": 1,
"transactions": 1
},
"transaction": {
"amount": 1
},
"week": {
"amount": 1,
"transactions": 1
}
}
},
"application_type": "CREDIT",
"description": "<string>"
}
'{
"is_enabled": true,
"name": "<string>",
"template": {
"account_type": "SAVING",
"bank_country": "US",
"currency": "USD",
"application_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"auto_payment_period": 20,
"balance_ceiling": {
"balance": 1,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"balance_floor": {
"balance": 123,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billing_period": {
"frequency": "ANNUALLY",
"start_date": "2022-01-01T00:00:00Z"
},
"fee_product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"grace_period": 21,
"interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_ach_enabled": false,
"is_card_enabled": false,
"is_eft_ca_enabled": true,
"is_external_card_enabled": false,
"is_p2p_enabled": false,
"is_sar_enabled": false,
"is_synctera_pay_enabled": false,
"is_wire_enabled": false,
"minimum_payment": {
"min_amount": 123,
"rate": 123,
"type": "RATE_OR_AMOUNT"
},
"overdraft_limit": 1,
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"spending_limits": {
"day": {
"amount": 1,
"transactions": 1
},
"description": "<string>",
"lifetime": {
"amount": 1,
"transactions": 1
},
"month": {
"amount": 1,
"transactions": 1
},
"transaction": {
"amount": 1
},
"week": {
"amount": 1,
"transactions": 1
}
},
"vendor_info": {
"vendor_data": {
"loanpro": {
"cash_advance_bucket_id": 67890,
"loc_product_id": 67890,
"purchases_bucket_id": 12345,
"tenant_id": "1"
}
},
"vendor_type": "LOANPRO"
}
},
"application_type": "CREDIT",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant": "abcdef_ghijkl"
}Update account template
Update account template
curl --request PUT \
--url https://api.synctera.com/v2/accounts/templates/{template_id} \
--header 'Content-Type: application/json' \
--data '
{
"is_enabled": true,
"name": "<string>",
"template": {
"account_type": "SAVING",
"bank_country": "US",
"currency": "USD",
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_ach_enabled": true,
"is_card_enabled": true,
"is_eft_ca_enabled": true,
"is_external_card_enabled": true,
"is_p2p_enabled": true,
"is_synctera_pay_enabled": true,
"is_wire_enabled": true,
"balance_ceiling": {
"balance": 1,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"balance_floor": {
"balance": 123,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"fee_product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_sar_enabled": false,
"overdraft_limit": 1,
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"spending_limits": {
"day": {
"amount": 1,
"transactions": 1
},
"description": "<string>",
"lifetime": {
"amount": 1,
"transactions": 1
},
"month": {
"amount": 1,
"transactions": 1
},
"transaction": {
"amount": 1
},
"week": {
"amount": 1,
"transactions": 1
}
}
},
"application_type": "CREDIT",
"description": "<string>"
}
'{
"is_enabled": true,
"name": "<string>",
"template": {
"account_type": "SAVING",
"bank_country": "US",
"currency": "USD",
"application_workflow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"auto_payment_period": 20,
"balance_ceiling": {
"balance": 1,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overflow_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"balance_floor": {
"balance": 123,
"linked_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"overdraft_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
},
"bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"billing_period": {
"frequency": "ANNUALLY",
"start_date": "2022-01-01T00:00:00Z"
},
"fee_product_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"grace_period": 21,
"interest_product_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_ach_enabled": false,
"is_card_enabled": false,
"is_eft_ca_enabled": true,
"is_external_card_enabled": false,
"is_p2p_enabled": false,
"is_sar_enabled": false,
"is_synctera_pay_enabled": false,
"is_wire_enabled": false,
"minimum_payment": {
"min_amount": 123,
"rate": 123,
"type": "RATE_OR_AMOUNT"
},
"overdraft_limit": 1,
"spend_control_ids": [
"7d943c51-e4ff-4e57-9558-08cab6b963c7"
],
"spending_limits": {
"day": {
"amount": 1,
"transactions": 1
},
"description": "<string>",
"lifetime": {
"amount": 1,
"transactions": 1
},
"month": {
"amount": 1,
"transactions": 1
},
"transaction": {
"amount": 1
},
"week": {
"amount": 1,
"transactions": 1
}
},
"vendor_info": {
"vendor_data": {
"loanpro": {
"cash_advance_bucket_id": 67890,
"loc_product_id": 67890,
"purchases_bucket_id": 12345,
"tenant_id": "1"
}
},
"vendor_type": "LOANPRO"
}
},
"application_type": "CREDIT",
"description": "<string>",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant": "abcdef_ghijkl"
}Path Parameters
Account Template ID
"a8943c51-e4ff-4e57-9558-08cab6b963c0"
Body
Account template to update
Whether this template can be used for account creation
Unique account template name
Rails available to enable on depository accounts
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
Show child attributes
Show child attributes
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
- 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.
SAVING, CHECKING, PREPAID, LINE_OF_CREDIT, CHARGE_SECURED, CHARGE_UNSECURED, REVOLVING_CREDIT_SECURED, REVOLVING_CREDIT_UNSECURED, GENERAL_LEDGER Bank country of the account. ISO 3166-1 Alpha-2 or Alpha-3 country code.
"US"
Account currency. ISO 4217 alphabetic currency code
"USD"
The bank account ID for this account. This is a unique identifier for the bank side account that this Synctera account belongs to. This field can be auto filled if only one bank account of the appropriate type exist for the tenant of concern.
A flag to indicate whether ACH transactions are enabled.
A flag to indicate whether card transactions are enabled.
A flag to indicate whether EFT Canada transactions are enabled.
A flag to indicate whether external card transactions are enabled.
A flag to indicate whether P2P transactions are enabled.
A flag to indicate whether Synctera Pay transactions are enabled.
A flag to indicate whether wire transactions are enabled.
Show child attributes
Show child attributes
Maximum balance in the account's currency. Unit in cents.
x >= 0ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling
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.
Show child attributes
Show child attributes
Minimum balance in the account's currency. Unit in cents.
ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor
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.
A list of fee account products that the current account associates with.
An interest account product that the current account associates with.
Enable SAR report.
This field is unused and will be removed in a future API version.
x >= 0List of spend control IDs to control spending for the account
20Account spending limits is unused and has been deprecated. Instead use the spend controls API.
Show child attributes
Show child attributes
Limit over a specific time period.
User provided description on the spending limits
Limit over a specific time period.
Show child attributes
Show child attributes
Limit over a specific time period.
Limit over a specific time period.
The type of the application to require.
- CREDIT: Credit application
- LINE_OF_CREDIT: (Deprecated) Line of credit application (if provided, this will be converted to a CREDIT type in the response)
- RESTRICTED_ACCOUNT: restricted account application
CREDIT, LINE_OF_CREDIT, RESTRICTED_ACCOUNT User provided account template description
Response
Account template updated
Whether this template can be used for account creation
Unique account template name
Show child attributes
Show child attributes
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
- 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.
SAVING, CHECKING, PREPAID, LINE_OF_CREDIT, CHARGE_SECURED, CHARGE_UNSECURED, REVOLVING_CREDIT_SECURED, REVOLVING_CREDIT_UNSECURED, GENERAL_LEDGER Bank country of the account
"US"
Account currency. ISO 4217 alphabetic currency code
"USD"
Taktile workflow ID for credit application processing
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 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.
0 <= x <= 2820
Show child attributes
Show child attributes
Maximum balance in the account's currency. Unit in cents.
x >= 0ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance ceiling
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.
Show child attributes
Show child attributes
Minimum balance in the account's currency. Unit in cents.
ID of linked backing account for just-in-time (JIT) funding of transactions to maintain the balance floor
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.
The bank account ID for this account. This is a unique identifier for the bank side account that this Synctera account belongs to. This field can be auto filled if only one bank account of the appropriate type exist for the tenant of concern.
The scheme for determining an account's billing period.
Show child attributes
Show child attributes
The frequency of billing cycles. Along with the start date, this will determine the start and end of each cycle.
ANNUALLY, MONTHLY, SEMI_MONTHLY, BI_WEEKLY, WEEKLY, DAILY 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.
"2022-01-01T00:00:00Z"
A list of fee account products that the current account associates with.
The number of days past the billing period to allow for payment before it is considered due. This directly infers the due date for a payment. The default will be set to 21 days.
21 <= x <= 28An interest account product that the current account associates with.
Enable ACH transaction on ledger.
Enable card transaction on ledger.
A flag to indicate whether EFT Canada transactions are enabled.
Enable external card transaction on ledger.
Enable P2P transaction on ledger.
Enable SAR report.
Enable Synctera Pay transaction on ledger.
Enable wire transaction on ledger.
The scheme for calculating the minimum payment due for outstanding balances in a billing period.
- Option 1
- Option 2
Show child attributes
Show child attributes
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.
The percentage of the balance to use, in basis points. For example, to set 12.5% of the balance, set this value to 1250.
- 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.
RATE_OR_AMOUNT, FULL This field is unused and will be removed in a future API version.
x >= 0List of spend control IDs to control spending for the account
20Account spending limits is unused and has been deprecated. Instead use the spend controls API.
Show child attributes
Show child attributes
Limit over a specific time period.
User provided description on the spending limits
Limit over a specific time period.
Show child attributes
Show child attributes
Limit over a specific time period.
Limit over a specific time period.
Vendor information for account templates
Show child attributes
Show child attributes
Vendor-specific data for templates
Show child attributes
Show child attributes
LoanPro-specific vendor data for template
Show child attributes
Show child attributes
LoanPro cash advance bucket ID
x >= 167890
LoanPro line of credit product ID
x >= 167890
LoanPro purchases bucket ID
x >= 112345
LoanPro tenant ID
1"1"
The type of vendor managing this account
LOANPRO "LOANPRO"
The type of the application to require.
- CREDIT: Credit application
- LINE_OF_CREDIT: (Deprecated) Line of credit application (if provided, this will be converted to a CREDIT type in the response)
- RESTRICTED_ACCOUNT: restricted account application
CREDIT, LINE_OF_CREDIT, RESTRICTED_ACCOUNT Account template description
Generated ID for the template
The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
"abcdef_ghijkl"
Was this page helpful?