Users
Get User Payout Volume
Total payout volume received by a user over a timeframe.
Total payout volume received by a user over a timeframe.
Authorization
api_key AuthorizationBasic <token>
In: header
Path Parameters
user_id*string
Id of the user to report on
Format
uuidQuery Parameters
timeframe?string
Window to report over.
Default
"all_time"Value in
- "1d"
- "3d"
- "1w"
- "1m"
- "3m"
- "1y"
- "all_time"
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v2/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/metrics/payouts"{ "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5", "timeframe": "string", "payouts_volume": 0, "currency": "usd"}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}{ "success": false, "message": "string", "error_code": "string", "errors": [ null ]}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.