Links
Links
Endpoints
- 1 refresh per link per hour for account data
- 1 refresh per link per hour for transaction data
- 1 refresh per link per day for account numbers
- 1 refresh per link per day for identity data
Get Link Details
Fetches details about a link.
Update Link
Updates the link configuration.
Delete Link
Deletes this link and disables its access token.
After deletion, the link id and access token are no longer valid and cannot be used to access any data that was associated with it. MoneyKit retains a bare-minimum record of the deleted link for a period (90 days) after deletion, so that your app can fetch the link by its ID and see that it is deleted; but after 90 days, the link will be hard-deleted and is no longer accessible in any way.
Refresh Products
Requests an update of the provided products for the link.
This is an asynchronous operation. The response will be a 202 Accepted if the request was successful.
Refreshes are subject to rate limiting.
Rate Limiting
Import Link
Creates a new link with pre-populated accounts and (optionally) transactions. The new link will
be created in an initially disconnected
state, with an error code of auth_expired
, but all data will be available.
As with any disconnected link, the imported link can then be reconnected at any time by starting a new
/link-session with existing_link_id
set to the link's link_id
. Note that the link can be
reconnected using any suitable provider.
The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted. For large imports, you should set generous HTTP read timeouts to avoid disconnecting before the import is complete. Alternatively, you can import only accounts, and then use the import-transactions endpoint to add transactions in batches.
Import Transactions
Adds transactions to a link imported with the import endpoint. The imported data has a maximum size limit of 1MB, which corresponds very roughly to about 4000 transactions. The data is processed synchronously, so you can expect a delay of up to 10 seconds before the response is transmitted.
Reset Link
Forcibly disconnects a link, for testing purposes.
Get Active Links
Gets the list of all active links. Active links are those that have been connected and
for which data has been fetched, and which have not been deleted. The list is cursor-paged; submit the
next_cursor
value to get the next page of links.