- Payouts
- Create a payout
Payouts
Create a payout
POST
/api/api/payouts/create
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/api/payouts/create \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"user_id": "string",
"amount": number,
"payout_method": "string"
}'
{
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"amount": 0,
"payout_method": "paypal",
"ach_account_id": "string",
"intl_account_id": "string",
"fund": true
}
{
"success": true,
"error_code": 0
}
Body
user_idRequired
string
amountRequired
number
payout_methodRequired
string
Available options:
paypal
, venmo
, ach
, cash_app
, intl_transfer
, default
ach_account_id
string
Account id from /users/get if payout_method is ach
intl_account_id
string
Account id from /users/get{user_id}/intl_bank_accounts if payout_method is intl_transfer
fund
boolean
Pays the payout amount to the user before creating the payout. The funds are returned if the payout does not succeed.
Response
success
boolean
error_code
integer
Error code if success is false
{
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"amount": 0,
"payout_method": "paypal",
"ach_account_id": "string",
"intl_account_id": "string",
"fund": true
}
{
"success": true,
"error_code": 0
}