Finances (deprecated)
Retrieve data about the finances of users.
The Finances endpoint has been deprecated as of June 10, 2021.
Endpoints#
To retrieve a finance object, call GET /v1/finances/{id}
.
To list all finance objects, call GET /v1/finances
.
Example finance object#
1{ 2 "id":"1f24c447-d645-41ab-afb7-e81b1db699c5", 3 "account":"810a054e-8133-4411-9722-12ebd6db040f", 4 "employer":"uber", 5 "created_at":"2020-09-10T17:12:49.715371Z", 6 "updated_at":"2020-09-11T08:52:38.138449Z", 7 "balance":"300.50", 8 "balance_currency":"USD", 9 "payout_method":"direct deposit" 10}
Attributes#
id
(string) — Unique ID of the finance object associated with a user's data partner account.
account
(string) — ID of the account associated with the finance object.
employer
(string) — The name of the company or entity that employs the user.
balance
(string) — Current balance.
balance_currency
(string) — Currency of current balance.
payout_method
(string) — Denotes the payout method chosen by the user. Payroll platforms might have different names for payout methods (e.g. direct deposit, instant cashout, check).