Skip to main content
POST
Create bank account

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
nuban
string
required

Account number / NUBAN.

account_name
string
required

Legal account holder name.

bank_name
string
required

Unique display name for this bank in Tyms. Used as payment_category on transactions.

opening_balance
number
required

Opening balance amount (can be negative for overdraft).

opening_balance_date
string<date>
required

Date of the opening balance entry.

account_code
string

GL code; auto-assigned if omitted.

currency
string

Currency code; defaults to business currency.

country
string

Country code; defaults to business country.

opening_balance_exchange_rate
number

Exchange rate for the opening balance. Default 1.

Response

Bank created with opening balance

status
string
required
Example:

"success"

message
string
required
data
any

Single resource, array of resources, statement sections, or async job metadata — see each operation's example.

meta
object

Pagination (page, limit, total) and/or report range (from, to). Cash flow may include previous_period_end.