Create account
POST/Accounts
Create account
Request​
- application/json
Body
Account to create.
- Array [
- ]
The code representing the account's current status.
The current balance of the account.
The approved overdraft limit for the account.
The code of the branch currently holding the account.
The code of the banking product associated with this account.
The date and time of the most recent transaction on this account.
The code identifying the account type.
The account number.
The International Bank Account Number (IBAN).
The ISO currency code (e.g., EUR, USD).
The code of the branch where the account was opened.
The date when the account was activated.
createInfo object
Audit metadata capturing who created this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
accountBeneficiaries object[]nullable
The list of beneficiaries associated with this account.
The unique code identifying the customer.
Indicates whether this beneficiary is the primary beneficiary of the account.
createInfo object
Audit metadata capturing who created this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
Responses​
- 201
- 409
- 422
Account was created.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
The code representing the account's current status.
The current balance of the account.
The approved overdraft limit for the account.
The code of the branch currently holding the account.
The code of the banking product associated with this account.
The date and time of the most recent transaction on this account.
The code identifying the account type.
The display title of the account type.
The account number.
The International Bank Account Number (IBAN).
The ISO currency code (e.g., EUR, USD).
The display title of the currency.
The display title of the account status.
The code of the branch where the account was opened.
The display title of the branch where the account was opened.
The display title of the branch currently holding the account.
The display title of the banking product.
The date when the account was activated.
The total agreed amount for the account (e.g., loan principal).
The total amount paid to date.
createInfo object
Audit metadata capturing who created this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
accountBeneficiaries object[]nullable
The list of beneficiaries associated with this account.
The unique code identifying the customer.
Indicates whether this beneficiary is the primary beneficiary of the account.
createInfo object
Audit metadata capturing who created this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
updateInfo object
Audit metadata capturing who last updated this record and when.
The username or identifier of the user who performed the action.
The date and time when the action was performed.
{
"accountStatusCode": "string",
"currentBalance": 0,
"overdraftAmount": 0,
"holdingBranchCode": "string",
"productCode": "string",
"lastTransactionDate": "2024-07-29T15:51:28.071Z",
"accountTypeCode": "string",
"accountTypeTitle": "string",
"accountNumber": "string",
"iban": "string",
"currencyCode": "string",
"currencyTitle": "string",
"accountStatusTitle": "string",
"openBranchCode": "string",
"openBranchTitle": "string",
"holdingBranchTitle": "string",
"productTitle": "string",
"dateActivated": "2024-07-29T15:51:28.071Z",
"agreedTotalAmount": 0,
"paidAmount": 0,
"createInfo": {
"actionBy": "string",
"actionAt": "2024-07-29T15:51:28.071Z"
},
"updateInfo": {
"actionBy": "string",
"actionAt": "2024-07-29T15:51:28.071Z"
},
"accountBeneficiaries": [
{
"customerCode": "string",
"isMainBeneficiary": true,
"createInfo": {
"actionBy": "string",
"actionAt": "2024-07-29T15:51:28.071Z"
},
"updateInfo": {
"actionBy": "string",
"actionAt": "2024-07-29T15:51:28.071Z"
}
}
]
}
Account already exists.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}
Unprocessable Entity.
- application/json
- Schema
- Example (from schema)
Schema
- Array [
- ]
- Array [
- ]
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
reasons object[]nullable
The list of underlying error reasons.
The error or validation message.
metadata objectnullable
Additional metadata associated with this record.
The list of underlying error reasons.
The unique code identifying this entity.
errors object[]nullable
The list of validation errors.
The name of the field that failed validation.
The error or validation message.
{
"message": "string",
"metadata": {},
"reasons": [
{
"message": "string",
"metadata": {},
"reasons": [
null
]
}
],
"code": 0,
"errors": [
{
"field": "string",
"message": "string"
}
]
}