Skip to navigation

Deposits

View as Markdown

Term deposits and other guaranteed savings products.

Each deposit carries the amount, the currency, the agreed rate, the dates it runs between and its state at the moment of the extraction. Field by field in Deposits & savings.

Requires the deposits_read feature

Features are chosen when the execution starts, not here. An execution that did not ask for deposits_read answers 204, and the only way to get the data is to run another one.

StatusMeaning
200The deposits.
202feature_not_ready — deposits_read is still running. Only this family waits: the ones that already closed answer now.
204The execution never asked for deposits_read. No body.
404No execution with that id for your application, or it has been deleted.

Server to server only. This call is authorised with your application secret: it belongs in your backend, never in a browser, a mobile app or anything your customer can read.

Authentication

X-APP-SECRETstring
Application Secret

Path parameters

execution_idstringRequiredformat: "object-id"
The execution, as the acceptance response returned it.

Response

200 OK
Time deposits and savings goals: what is locked away, at what rate, and until when.

An empty list is an answer, not a gap: the feature ran and the source reported none.

Time Depositobject
OR
Savings Goalobject

Errors

404
Not Found Error
422
Unprocessable Entity Error