POST
/
internal_accounts
Add internal accounts
curl --request POST \
  --url https://api-sandbox.synctera.com/v0/internal_accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "account_type": "ACH_SETTLEMENT",
  "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "currency": "USD",
  "description": "<string>",
  "gl_type": "ASSET",
  "is_system_acc": false,
  "purpose": "CORE",
  "status": "ACTIVE"
}'
{
  "tenant": "abcdef_ghijkl",
  "account_number": "<string>",
  "account_type": "ACH_SETTLEMENT",
  "balances": [
    {
      "balance": 2399,
      "type": "ACCOUNT_BALANCE"
    }
  ],
  "bank_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "bank_routing": "<string>",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "description": "<string>",
  "gl_type": "ASSET",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_system_acc": false,
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "purpose": "CORE",
  "status": "ACTIVE"
}

Authorizations

​
Authorization
string
header
required

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

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
​
currency
string
required

Account currency or account settlement currency. ISO 4217 alphabetic currency code.

Example:

"USD"

​
status
enum<string>
required
Available options:
ACTIVE
​
account_type
enum<string>

type associated with the internal account.

Available options:
ACH_SETTLEMENT,
ACH_SUSPENSE,
ALLOCATED_SUSPENSE,
BANK_DRAFT,
BILLING_EXPENSE,
BILLING_REVENUE,
CARD_AFT_PREFUNDING,
CARD_OCT_SETTLEMENT,
CARD_SETTLEMENT,
CASH_SETTLEMENT,
CASH_SUSPENSE,
CHECK_SETTLEMENT,
DISPUTE_WRITE_OFF_PNL,
EFT_CA_SETTLEMENT,
EFT_CA_SUSPENSE,
EXTERNAL_CARD_AFT_SETTLEMENT,
EXTERNAL_CARD_OCT_SETTLEMENT,
FEDNOW_SETTLEMENT,
FEES,
FRAUD_LOSSES,
FUNDING_ACCOUNTS,
GENERAL_PNL,
INTEREST_PAYOUT,
INTERNATIONAL_WIRE_SETTLEMENT,
LOC_INTEREST_INCOME,
LOC_INVESTOR_PORTFOLIO,
LOC_REPURCHASE,
MONEY_IN_AND_OUT,
NEGATIVE_BALANCE,
NETWORK_ADJUSTMENT,
NETWORK_CHARGEBACK,
NEW_FUNDING_ACCOUNT,
PROVISIONAL_CREDIT_PNL,
RESERVE,
REWARDS,
SC_INVESTOR_PORTFOLIO,
SC_REPURCHASE,
SYNCTERA_PAY_SUSPENSE,
USC_INTEREST_INCOME,
USC_INVESTOR_PORTFOLIO,
USC_REPURCHASE,
WIRE_SETTLEMENT,
WIRE_SUSPENSE,
WRITE_OFF
​
bank_account_id
string<uuid>

The ID of the bank account associated with this internal account. It will be auto-filled if the account type has only one matching bank account in the system.

​
description
string

A user provided description for the current account

​
gl_type
enum<string>

What type of general ledger account this internal account represents.

Available options:
ASSET,
EXPENSE,
LIABILITY,
REVENUE
​
is_system_acc
boolean
default:false

Is a system-controlled internal account. When this field is true, this internal account will be reserved exclusively for internal use by the Synctera platform and any internal transfers to or from this internal account will be declined.

​
purpose
enum<string>

The purpose of the internal account. On creation, the default is PROFIT_AND_LOSS.

Available options:
CORE,
PROFIT_AND_LOSS,
RESERVE,
SETTLEMENT,
SUSPENSE,
TREASURY

Response

The internal account added.

​
currency
string
required

Account currency or account settlement currency. ISO 4217 alphabetic currency code.

Example:

"USD"

​
status
enum<string>
required
Available options:
ACTIVE
​
account_number
string

Generated internal account number

​
account_type
enum<string>

type associated with the internal account.

Available options:
ACH_SETTLEMENT,
ACH_SUSPENSE,
ALLOCATED_SUSPENSE,
BANK_DRAFT,
BILLING_EXPENSE,
BILLING_REVENUE,
CARD_AFT_PREFUNDING,
CARD_OCT_SETTLEMENT,
CARD_SETTLEMENT,
CASH_SETTLEMENT,
CASH_SUSPENSE,
CHECK_SETTLEMENT,
DISPUTE_WRITE_OFF_PNL,
EFT_CA_SETTLEMENT,
EFT_CA_SUSPENSE,
EXTERNAL_CARD_AFT_SETTLEMENT,
EXTERNAL_CARD_OCT_SETTLEMENT,
FEDNOW_SETTLEMENT,
FEES,
FRAUD_LOSSES,
FUNDING_ACCOUNTS,
GENERAL_PNL,
INTEREST_PAYOUT,
INTERNATIONAL_WIRE_SETTLEMENT,
LOC_INTEREST_INCOME,
LOC_INVESTOR_PORTFOLIO,
LOC_REPURCHASE,
MONEY_IN_AND_OUT,
NEGATIVE_BALANCE,
NETWORK_ADJUSTMENT,
NETWORK_CHARGEBACK,
NEW_FUNDING_ACCOUNT,
PROVISIONAL_CREDIT_PNL,
RESERVE,
REWARDS,
SC_INVESTOR_PORTFOLIO,
SC_REPURCHASE,
SYNCTERA_PAY_SUSPENSE,
USC_INTEREST_INCOME,
USC_INVESTOR_PORTFOLIO,
USC_REPURCHASE,
WIRE_SETTLEMENT,
WIRE_SUSPENSE,
WRITE_OFF
​
balances
object[]

A list of balances for internal account based on different type

​
bank_account_id
string<uuid>

The ID of the bank account associated with this internal account. It will be auto-filled if the account type has only one matching bank account in the system.

​
bank_routing
string

Bank routing number

Maximum length: 9
​
creation_time
string<date-time>

The date and time the resource was created.

Example:

"2010-05-06T12:23:34.321Z"

​
description
string

A user provided description for the current account

​
gl_type
enum<string>

What type of general ledger account this internal account represents.

Available options:
ASSET,
EXPENSE,
LIABILITY,
REVENUE
​
id
string<uuid>

Generated ID for internal account

​
is_system_acc
boolean
default:false

Is a system-controlled internal account. When this field is true, this internal account will be reserved exclusively for internal use by the Synctera platform and any internal transfers to or from this internal account will be declined.

​
last_updated_time
string<date-time>

The date and time the resource was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
purpose
enum<string>

The purpose of the internal account. On creation, the default is PROFIT_AND_LOSS.

Available options:
CORE,
PROFIT_AND_LOSS,
RESERVE,
SETTLEMENT,
SUSPENSE,
TREASURY
​
tenant
string

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

Example:

"abcdef_ghijkl"