MySQL
cofre_users
Table name: cofre_users
Description: Table to store users registered in the Cofre Platform
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table. |
|
|
name |
String |
User’s name. |
|
|
msisdn |
String |
User’s mobile phone. |
|
|
|
String |
User’s email address. |
|
|
cpf |
String |
User’s CPF. |
|
|
password |
String |
User’s password (encrypted). |
|
|
identifier |
String |
An unique identification of the user supplied by Cofre before submit a customer creation to Salt Edge |
|
|
saltedge_customer_id |
Integer |
An identification of the customer supplied by Salt Edge when the customer was created
A Customer represents a single end-user of the Account Information API. The customer uses the API to create Connections, i.e. bank connections, that are further used to aggregate the customer's financial data. |
https://www.saltedge.com/api/v5/customers |
|
saltedge_secret |
String |
A secret generated by Salt Edge when the customer was created. |
https://www.saltedge.com/api/v5/customers |
|
uuid |
String |
UUID generated by Google Firebase. Used for identify the user in sign-in process. |
|
|
pin |
String |
Personal Identification Number (6 digits) for mobile phone or email validation. It will be used for register process or password recovery. |
|
|
status |
Integer |
Status of the user for the Cofre platform.
User’s status could be: 0 – Inactive 1 – Active 2 – Suspended |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table. |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table. |
|
cofre_connections
Table name: cofre_connections
Description: Table to store all Salte Edge users' connections.
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table |
|
|
userID |
Integer |
The id of the user in table cofre_users |
|
|
saltedge_connection_id |
String |
The id of the connection supplied by Salt Edge when the connection was created |
https://www.saltedge.com/api/v5/connections |
|
status |
Integer |
Status of the connection for the Cofre platform
A connection could be: 0 – Inactive 1 – Active 2 - Waiting saltedge_connection_id |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table |
|
cofre_providers
Table name: cofre_providers
Description: Table to store all Salt Edge providers available for Cofre's users
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table |
|
|
saltedge_provider_code |
String |
The code of the provider |
https://www.saltedge.com/api/v5/providers |
|
provider_name |
String |
Given name (label) of the provider for front-end using |
|
|
saltedge_logo_url |
String |
Image to identify the provider |
https://www.saltedge.com/api/v5/providers |
|
status |
Integer |
Providers should be: 0 – Inactive (is not showed by the app) 1 – Active |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table |
|
cofre_accounts
Table name: cofre_accounts
Description: Table to store the users' accounts
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table |
|
|
connectionsID |
Integer |
The id of the related connection in table cofre_connections |
|
|
saltedge_account_id |
String |
The id of the account |
https://www.saltedge.com/api/v5/accounts? connection_id={connection.id} |
|
status |
Integer |
Status of the user for the Cofre platform
The accounts could be: 0 – Inactive 1 – Active |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table |
|
cofre_transactions
Table name: cofre_transactions
Description: Table to store account transactions and savings
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table. |
|
|
connectionsID |
Integer |
The id of the related connection in table cofre_connections. |
|
|
accountsID |
Integer |
The id of the related account in table cofre_accounts. |
|
|
saltedge_transaction_id |
String |
The id of the transaction.
Field |
https://www.saltedge.com/api/v5/transactions?connection_id={connection.id}&account_id={account.id} |
|
saltedge_amount |
Decimal |
The amount of the transaction.
Field |
https://www.saltedge.com/api/v5/transactions?connection_id={connection.id}&account_id={account.id} |
|
amount_saved |
Decimal |
The amount saved (AS): The percentage is defined by the Cofre’s user. |
|
|
status |
Integer |
Status of the transaction selected by the user to calculate a saving for the Cofre platform.
Transactions could be: 0 – Selected, but not processed 1 – Saved 2 – Processing 3 – Technical error. Must be analysed 5 – Not approved by payment gateway 6 – Retrieve asked by the user 7 – Retrieve processed |
|
|
saltedge_made_on |
Datetime |
The date when the transaction was made.
Field |
https://www.saltedge.com/api/v5/transactions?connection_id={connection.id}&account_id={account.id} |
|
dt_saving |
Datetime |
Date and time when the saving was responded by the payment gateway. |
|
|
dt_retrieve |
Datetime |
Date and time when the user asked a retrieving. |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table. |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table. |
|
cofre_users_parms
Table name: cofre_users_parms
Description: Table to store parameters for each user, like preferences, UI settings, percentage to saving etc.
|
Field |
Type |
Description |
API |
|
ID |
Integer |
Sequential number of the registry in the table |
|
|
userID |
Integer |
The id of the user in table cofre_users |
|
|
category |
String |
Where the parameter will be used. A category is keyword used to identify a set of data.
|
|
|
value |
JSON |
JSON with all parameters referred to the category. }
All these key/values pair should be defined in another document. |
|
|
status |
Integer |
A parameter could be: 1 – Active |
|
|
datainsert |
Timestamp |
Date and time when the registry was inserted in the table |
|
|
dataupdate |
Timestamp |
Date and time of the last update of the registry in the table |
|