Users
Get User Payout Volume
Total payout volume received by a user over a timeframe.
GET
Total payout volume received by a user over a timeframe.
api_keyheader
AuthorizationBasic <token>user_id*stringId of the user to report on
Format
uuidtimeframe?stringWindow to report over.
Default
"all_time"Value in
"1d""3d""1w""1m""3m""1y""all_time"OK
application/json- response
user_id?stringFormat
uuidtimeframe?stringpayouts_volume?numberTotal volume received, in cents.
currency?stringExample Request
curl -X GET 'https://api.dots.dev/api/v2/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics/payouts'Example Response
{ "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "timeframe": "string", "payouts_volume": 0, "currency": "usd"}Add a Payout Method
Add a payout method to the user. Payout method can be one of `paypal`, `venmo`, `ach`, or `cash_app`. Each method has different required parameters.
Connect an Existing User to an App
Connect a user who already exists elsewhere in your organization to another App, so the same person can be paid from both without re-onboarding. Requires organization credentials. The user must belong to the calling organization and be active.