Skip to main content
POST
Create bank account
BankName and CurrencyId are required. Also send either Iban, or Branch together with AccountNumber.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

customerId
string<uuid>
required

Customer ID.

Body

BankName
null | string

Required. Bank name.

Example:

"Example Bank"

Branch
null | string

Branch. Required together with AccountNumber when Iban is empty.

Example:

"Kadıköy"

AccountNumber
null | string

Account number. Required together with Branch when Iban is empty.

Example:

"12345678"

Iban
null | string

IBAN. Required when Branch and AccountNumber are empty.

Example:

"TR330006100519786457841326"

CurrencyId
null | string<uuid>

Required. ID of a currency from GET /api/v1/definitions/currencies.

Description
null | string

Description.

Response

Created

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.