Input:
For more details about this API input data type please refer to this article.
Output:
Path | Variable | Data Types | Description |
|---|---|---|---|
| HttpStatusCode | HttpStatusCode | number | A message that indicates whether or not that request can be fulfilled (See article) |
| Accounts | Accounts | object | Contains all retrieved user accounts |
| Accounts\Transactions | Transactions | object | Contains all retrieved transactions for that account |
| Accounts\Transactions\Date | Date | string, null | Transaction date |
| Accounts\Transactions\Code | Code | number, null | Deprecated field |
| Accounts\Transactions\Description | Description | string, null | Transaction description as presented by the financial institution |
| Accounts\Transactions\Debit | Debit | number, null | Transaction debit amount |
| Accounts\Transactions\Credit | Credit | number, null | Transaction credit amount |
| Accounts\Transactions\Balance | Balance | number, null | Account balance after the transaction |
| Accounts\Transactions\Id | Id | string, null | Flinks' transaction ID |
| Accounts\TransitNumber | TransitNumber | string, null | The number that identifies your financial institution's branch |
| Accounts\InstitutionNumber | InstitutionNumber | string, null | The number that identifies a financial institution |
| Accounts\Title | Title | string, null | Account title as presented by the financial institution |
| Accounts\AccountNumber | AccountNumber | string, null | Account number |
| Accounts\Balance | Balance | object | Contains the balance information for a given account |
| Accounts\Balance\Available | Available | number, null | Balance considering both posted and authorized transactions |
| Accounts\Balance\Current | Current | number, null | Balance considering posted transactions |
| Accounts\Balance\Limit | Limit | number, null | The maximum amount a user can have debited from the account |
| Accounts\Category | Category | string, null | Account categories: operations, credits, products, other. (See article) |
| Accounts\Type | Type | string, null | Account types: checking, savings, credit card, TFSA, RRSP, unkown. (See article) |
| Accounts\Currency | Currency | string, null | Account currency: only supported in CAD and USD |
| Accounts\Holder | Holder | object | Contains the account holder's information |
| Accounts\Holder\Name | Name | string, null | Account holder's name |
| Accounts\Holder\Address | Address | object, null | Contains the account holder's address |
| Accounts\Holder\Address\CivicAddress | CivicAddress | string, null | Account holder's civic address |
| Accounts\Holder\Address\City | City | string, null | Account holder's city |
| Accounts\Holder\Address\Province | Province | string, null | Account holder's province/state |
| Accounts\Holder\Address\PostalCode | PostalCode | string, null | Account holder's postal code |
| Accounts\Holder\Address\POBox | POBox | string, null | Account holder's po box |
| Accounts\Holder\Address\Country | Country | string, null | Account holder's country |
| Accounts\Holder\Email | string, null | Account holder's email | |
| Accounts\Holder\PhoneNumber | PhoneNumber | string, null | Account holder's phone number |
| Accounts\Id | Id | string, null | Flinks' account ID |
| Login | Login | object, null | Contains the login data |
| Login\Username | Username | string, null | Card user name |
| Login\IsScheduledRefresh | IsScheduledRefresh | boolean, null | If Nightly Refreshes are enabled for that card. (See article) |
| Login\LastRefresh | LastRefresh | string, null | Last refresh date |
| Login\Type | Type | string, null | Login type: personal, business |
| Login\Id | Id | string, null | Flinks' Loginid is a unique key that represents that a connected account (See article) |
| InstitutionId | InstitutionId | number, null | Flinks' Financial Institution ID |
| Institution | Institution | string, null | Financial Institution name |
| RequestId | RequestId | string, null | Flinks' RequestId is a unique key that can be used to make calls to other data retrieval endpoints (See article) |