Create accounts
This endpoint allows to create accounts that are not directly connected to a bank account.
Request
POST /insights/v1/storage/accounts/create HTTP/1.1
Content-Type: application/json; charset=utf-8
Authorization: Token <Token>
Host: <Host>
{
"insights_consumer_id": ?String,
"data_retention_minutes": ?Integer,
"account": {
"insights_account_id": ?String,
"iban": : ?String,
"account_number": ?String,
"alias": ?String,
"bic": ?String,
"bank_code": ?String,
"holder_name": ?String,
"account_type": ?Enum<'DEFAULT', 'SAVING', 'CREDITCARD', 'DEPOT'>,
"transfer_type": ?Enum<'NONE', 'DOMESTIC', 'FULL', 'REFERENCE', 'RESTRICTED'>,
"currency": ?String,
"holder_address": ?{
"country": ?String
}
}
}
Data provided with this call will be stored with this insights_consumer_id
. Any string with less than 128 characters can be used to identify the consumer. If left empty, a new identifier will be generated and returned in the response to this call.
How long the data should be stored until expiring. If this property is not set the default is 10 minutes.
The accounts Account Insights id. Can be any string up to 128 characters. If left empty, a new identifier will be generated and returned in the response to this call.
The accounts iban.
The accounts account number.
The accounts alias. Allows up to 150 characters.
The accounts bic.
The accounts bank code.
The accounts holder name. Allows up to 160 characters.
The accounts account type.
DEFAULT
- A regular account.SAVING
- A savings account.CREDITCARD
- A credit card account.DEPOT
- A depot for broking or similar.
The accounts transfer type.
NONE
- It is not possible to use the account for transfers.DOMESTIC
- The account can only be used for domestic transfers.FULL
- The account is fully usable.REFERENCE
- The account can only be used for transfers to one specific account.RESTRICTED
- The account might be under protection from execution or something similar. Transfers are possible, but with restricted functionality (e.g. limited transfer amount).
The currency of the balance of this account. If this property is not set the default is XXX
(as defined in ISO 4217).
The account country as code in the ISO 3166-1 alpha-2 format, e.g. DE
, GB
, SE
.
Response
{
"data": {
"insights_consumer_id" : String,
"insights_account_id" : String
}
}
The insights_consumer_id
of the stored data.
The insights_account_id
of the stored data.