Skip to main content
GET
/
accounts
/
templates
List account templates
curl --request GET \
  --url https://api.synctera.com/v2/accounts/templates
{
  "account_templates": [
    {
      "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": 2,
        "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"
    }
  ],
  "next_page_token": "a8937a0d"
}

Query Parameters

​
account_type
enum<string>

The type of the account

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.
Available options:
SAVING,
CHECKING,
PREPAID,
LINE_OF_CREDIT,
CHARGE_SECURED,
CHARGE_UNSECURED,
REVOLVING_CREDIT_SECURED,
REVOLVING_CREDIT_UNSECURED,
GENERAL_LEDGER
​
limit
integer
default:100

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Required range: x >= 1
Example:

100

​
page_token
string

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:

"a8937a0d"

Response

200 - application/json

List of account templates

​
account_templates
object[]
required

Array of account templates

​
next_page_token
string

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example:

"a8937a0d"