Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Internal Accounts

Add internal accounts

Add an internal account. Note: In production, this action can only be performed by Synctera administrators.

post/internal_accounts

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

account_numberstring

Generated internal account number

account_type'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' | 'IN_STORE_CASH_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'

type associated with the internal account.

bank_account_idstring 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_routingstring

Bank routing number

creation_timestring date-time

The date and time the resource was created.

currencystring required

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

descriptionstring

A user provided description for the current account

gl_type'ASSET' | 'EXPENSE' | 'LIABILITY' | 'REVENUE'

What type of general ledger account this internal account represents.

idstring uuid

Generated ID for internal account

is_system_accboolean

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_timestring date-time

The date and time the resource was last updated.

purpose'CORE' | 'PROFIT_AND_LOSS' | 'RESERVE' | 'SETTLEMENT' | 'SUSPENSE' | 'TREASURY'

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

skip_sweepsboolean

Indicates if transactions of this internal account should be skipped by our sweeps system.

status'ACTIVE' required

Example request

{
  "balances": [
    {
      "balance": 2399
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "last_updated_time": "2010-05-06T12:23:34.321Z"
}

Response

The internal account added.

tenantstring

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

account_numberstring

Generated internal account number

account_type'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' | 'IN_STORE_CASH_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'

type associated with the internal account.

bank_account_idstring 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_routingstring

Bank routing number

creation_timestring date-time

The date and time the resource was created.

currencystring required

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

descriptionstring

A user provided description for the current account

gl_type'ASSET' | 'EXPENSE' | 'LIABILITY' | 'REVENUE'

What type of general ledger account this internal account represents.

idstring uuid

Generated ID for internal account

is_system_accboolean

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_timestring date-time

The date and time the resource was last updated.

purpose'CORE' | 'PROFIT_AND_LOSS' | 'RESERVE' | 'SETTLEMENT' | 'SUSPENSE' | 'TREASURY'

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

skip_sweepsboolean

Indicates if transactions of this internal account should be skipped by our sweeps system.

status'ACTIVE' required

Example response

{
  "tenant": "abcdef_ghijkl",
  "balances": [
    {
      "balance": 2399
    }
  ],
  "creation_time": "2010-05-06T12:23:34.321Z",
  "currency": "USD",
  "last_updated_time": "2010-05-06T12:23:34.321Z"
}