action biapi_post_users_id_user_connections_id_connection_accounts {
label: "Create an account"
description: "This endpoint creates an account related to a connection or not.
"
provider: biapi
method: POST
path: "/users/{id_user}/connections/{id_connection}/accounts"
encoding: json
input: {
type: "object"
properties: {
expand: {
type: "string"
}
id_connection: {
type: "integer"
}
id_user: {
type: "string"
}
}
required: ["id_connection", "id_user"]
additionalProperties: false
}
output: {
type: "object"
required: ["balance", "bookmarked", "display", "id", "original_name"]
properties: {
balance: {
type: "number"
format: "float"
description: "Balance of the account"
}
bookmarked: {
type: "integer"
description: "This account has been bookmarked by user"
}
coming: {
type: "number"
format: "float"
description: "Amount of coming operations not yet debited"
}
company_name: {
type: "string"
description: "Name of the company holding the employee savings of the account"
}
currency: {
type: "object"
description: "Account currency"
}
deleted: {
type: "string"
format: "date-time"
description: "This account is not found on the website anymore"
}
disabled: {
type: "string"
format: "date-time"
description: "This account has been deleted by user and will not be synchronized anymore"
}
display: {
type: "boolean"
description: "Display this account in accounts list"
}
error: {
type: "string"
description: "If the last update has failed, the error code"
}
iban: {
type: "string"
description: "Account IBAN"
}
id: {
type: "integer"
description: "ID of the account"
}
id_connection: {
type: "integer"
description: "ID of the related connection"
}
id_parent: {
type: "integer"
description: "Id of the parent account"
}
id_source: {
type: "integer"
description: "ID of the related connection source"
}
id_type: {
type: "integer"
description: "ID of the account type"
}
id_user: {
type: "integer"
description: "ID of the related user"
}
last_update: {
type: "string"
format: "date-time"
description: "Last successful update of the account"
}
name: {
type: "string"
description: "Name of the account"
}
number: {
type: "string"
description: "Account number"
}
opening_date: {
type: "string"
format: "date"
description: "Opening date of the account"
}
original_name: {
type: "string"
description: "Original name of the account on the bank"
}
ownership: {
type: "string"
description: "Relationship between the credentials owner and the account"
}
usage: {
type: "string"
description: "Account usage (if not set by the user, displays the value of original_usage)"
}
webid: {
type: "string"
description: "Account webid"
}
}
}
}