Users
Add Payout Methods
Users
Add Payout Methods
Add payout methods to a user's account
All requests to the /v2/users/* endpoints must include both the client_id
and api_key as detailed in the
Authentication document.
Payout methods can be added by a user’s account by the user through the UI components provided by Dots. For a more custom integration, you can use the /v2/users//payout-methods endpoint to do the same.
Add an ACH Account
Add a user’s bank account information to enable ACH payouts.
Method
Call the add_payout_method endpoint
curl https://pls.senddotssandbox.com/api/v2/users/{user_id}/payout-methods \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"platform": "ach",
"routing_number": "123456789",
"account_number": "123456789",
"account_type": "checking",
}'
response = {
"success": true,
"ach_account_id": "acc_dfsf983kkjdsf",
}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| platform | string | ✔️ | ach |
| routing_number | string | ✔️ | The routing number of the bank account |
| account_number | string | ✔️ | The account number of the bank account |
| account_type | string | ✔️ | The type of bank account. Must be checking or savings |
Add PayPal
Add a user’s PayPal email address to their account to enable PayPal payouts.
Method
Call the add_payout_method endpoint
curl https://pls.senddotssandbox.com/api/v2/users/{user_id}/payout-methods \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"platform": "paypal",
"email": "bob.loblaw@gmail.com"
}'
response = {
"success": true,
}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| platform | string | ✔️ | paypal |
| string | ✔️ | The email address of the PayPal account |
Add Venmo
Add a user’s Venmo phone number address to their account to enable Venmo payouts.
Method
Call the add_payout_method endpoint
> curl https://pls.senddotssandbox.com/api/v2/users/{user_id}/payout-methods \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"platform": "venmo",
"phone_number": "4158934432"
}'
> response = {
"success": true,
}
| Name | Type | Required | Description |
|---|---|---|---|
| platform | string | ✔️ | venmo |
| string | ✔️ | The phone number of the Venmo account |