- Payouts
- Send a Payout
Payouts
Send a Payout
Send a payout to a person when you know their phone number or user id. If the user has a Dots acconut, the funds will delivered according to their saved prefernces. Otherwise, they will be sent a Payout Link to onboard and recieve funds.
POST
/api/v2/payouts/send-payout
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts/send-payout \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"amount": integer
}'
Body
amountRequired
integer
The amount in cents to pay the user.
user_id
string
The user's id. user_id
or payee
is required.
payee
object
The payee's phone number. user_id
or payee
is required.
delivery
object
force_collect_compliance_information
boolean
Collect 1099 or w8-ben information.
metadata
string | object
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
memo
string
Add a memo to the top of the Payout Link
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts/send-payout \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"amount": integer
}'