Create custom account

Creates a custom account for a business. Custom accounts offer platforms direct control over bank account data and should be used for accounts operated directly by the platform.

POST /v1/businesses/{businessId}/custom-accounts

Create custom account

cURL

curl --request POST \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/custom-accounts/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_id": "ww9wwLgkrbU3jkg3J4J7ckBR3zKQV6sLPQevK",
  "mask": "4321",
  "account_name": "My custom account",
  "institution_name": "My custom account institution",
  "account_type": "DEPOSITORY",
  "account_subtype": "checking"
}
'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "ww9wwLgkrbU3jkg3J4J7ckBR3zKQV6sLPQevK",
  "mask": "4321",
  "account_name": "My custom account",
  "institution_name": "My custom account institution",
  "account_type": "DEPOSITORY",
  "account_subtype": "checking",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "ledger_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

Rate Limiting

This endpoint has a custom rate limit policy.

Rate Limit Details:

Environment	Limit	Refill Period	Initial Size
Sandbox	5 requests	1 second	10 requests
Production	20 requests	1 second	40 requests

Response Headers:

All responses include the following rate limit headers:

• X-RateLimit-Limit: The rate limit bucket capacity
• X-RateLimit-Remaining: The number of tokens remaining in the bucket
• X-RateLimit-Reset: UTC timestamp (in seconds) when the bucket will be refilled

For more details on rate limiting, see Rate Limiting.

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Content-Type · string

Content-Type must be set to application/json

Path Parameters

businessId · string · required

The UUID of the business to create custom account for.

Body

application/json

external_id · string

Unique ID of the custom account in an external system for linking and idempotency.

Example:

"ww9wwLgkrbU3jkg3J4J7ckBR3zKQV6sLPQevK"

mask · string

Last 4 digits of the custom account number

Example:

"4321"

account_name · string

Name of the custom account

Example:

"My custom account"

institution_name · string

Name of the institution for the custom account

Example:

"My custom account institution"

account_type · enum<string> | null

The type of the custom account

Available options: DEPOSITORY, CREDIT, LOAN

Example:

"DEPOSITORY"

account_subtype · enum<string> | null

The subtype of the custom account

Available options: CHECKING, SAVINGS, CREDIT CARD, LOAN

Example:

"checking"

Response

200

application/json

id · string<uuid>

Unique ID for the custom account

external_id · string

Unique ID of the custom account in an external system for linking and idempotency.

Example:

"ww9wwLgkrbU3jkg3J4J7ckBR3zKQV6sLPQevK"

mask · string | null

Last 4 digits of the custom account number

Example:

"4321"

account_name · string

Name of the account

Example:

"My custom account"

institution_name · string

Name of the institution for the custom account

Example:

"My custom account institution"

account_type · enum<string> | null

The type of the custom account

Available options: DEPOSITORY, CREDIT, LOAN

Example:

"DEPOSITORY"

account_subtype · enum<string> | null

The subtype of the custom account

Available options: CHECKING, SAVINGS, CREDIT CARD, LOAN

Example:

"checking"

created_at · string<date-time> | null

Timestamp of when the custom account was created

updated_at · string<date-time> | null

Timestamp of when the custom account was last created

archived_at · string<date-time> | null

Timestamp of when the custom account was archived

ledger_account_id · string<uuid> | null

The ID of the ledger account associated with the custom account