Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Accounts

List account templates

List account templates

get/accounts/templates

Query parameters

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.

The type of the account

page_tokenstring

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

Example:a8937a0d
limitinteger

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

Example:100

Response

List of account templates

next_page_tokenstring

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

Example response

{
  "next_page_token": "a8937a0d",
  "account_templates": [
    {
      "template": {
        "auto_payment_period": 20,
        "bank_country": "US",
        "billing_period": {
          "start_date": "2022-01-01T00:00:00Z"
        },
        "currency": "USD",
        "spend_control_ids": [
          "7d943c51-e4ff-4e57-9558-08cab6b963c7"
        ],
        "vendor_info": {
          "vendor_data": {
            "loanpro": {
              "cash_advance_bucket_id": 67890,
              "loc_product_id": 67890,
              "purchases_bucket_id": 12345,
              "tenant_id": "1"
            }
          },
          "vendor_type": "LOANPRO"
        }
      },
      "tenant": "abcdef_ghijkl"
    }
  ]
}