Skip to main content
POST
/
accounts
/
templates
Create an account template
curl --request POST \
  --url https://api.synctera.com/v2/accounts/templates \
  --header 'Content-Type: application/json' \
  --data '{
  "application_type": "CREDIT",
  "description": "<string>",
  "is_enabled": true,
  "name": "<string>",
  "template": {
    "account_type": "SAVING",
    "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "bank_country": "US",
    "currency": "USD",
    "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>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_enabled": true,
  "name": "<string>",
  "template": {
    "account_type": "SAVING",
    "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",
    "bank_country": "US",
    "billing_period": {
      "frequency": "ANNUALLY",
      "start_date": "2022-01-01T00:00:00Z"
    },
    "currency": "USD",
    "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"
    }
  },
  "tenant": "abcdef_ghijkl"
}

Headers

​
Idempotency-Key
string

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.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Body

application/json

Account template to create

​
is_enabled
boolean
required

Whether this template can be used for account creation

​
name
string
required

Unique account template name

​
template
object
required

Rails available to enable on depository accounts

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
​
application_type
enum<string>

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
Available options:
CREDIT,
LINE_OF_CREDIT,
RESTRICTED_ACCOUNT
​
description
string

User provided account template description

Response

201 - application/json

Account template created

​
is_enabled
boolean
required

Whether this template can be used for account creation

​
name
string
required

Unique account template name

​
template
object
required
​
application_type
enum<string>

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
Available options:
CREDIT,
LINE_OF_CREDIT,
RESTRICTED_ACCOUNT
​
description
string

Account template description

​
id
string<uuid>

Generated ID for the template

​
tenant
string

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"