Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Accounts

Create an account template

Create an account template. An account template is needed to create an account in a lead mode.

post/accounts/templates

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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

application_type'CREDIT' | 'LINE_OF_CREDIT' | 'RESTRICTED_ACCOUNT'

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
descriptionstring

User provided account template description

idstring uuid

Generated ID for the template

is_enabledboolean required

Whether this template can be used for account creation

namestring required

Unique account template name

Example request

{
  "template": {
    "bank_country": "US",
    "currency": "USD"
  }
}

Response

Account template created

application_type'CREDIT' | 'LINE_OF_CREDIT' | 'RESTRICTED_ACCOUNT'

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
descriptionstring

Account template description

idstring uuid

Generated ID for the template

is_enabledboolean required

Whether this template can be used for account creation

namestring required

Unique account template name

tenantstring

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

Example response

{
  "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"
}