- Payouts
- Create a payout link
Payouts
Create a payout link
POST
/api/api/payouts/create_payout_link
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/api/payouts/create_payout_link \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"delivery": {
},
"amount": number
}'{
"delivery": {
"method": "link"
},
"amount": 0,
"notes": null,
"tax_exempt": true,
"payee": {
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone_number": "string"
}
}
{
"success": true,
"payout_link": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "string",
"original_amount": 0,
"amount": 0,
"status": "created",
"api_app_name": "string",
"payee": {}
}
}
Body
deliveryRequired
object
amountRequired
number
notes
Custom data that will be attached to the transaction when the recipient claims the link.
tax_exempt
boolean
Flags as tax exempt for the purpose of collecting form 1099.
payee
object
Response
success
boolean
payout_link
object
The payout link if success is true
{
"delivery": {
"method": "link"
},
"amount": 0,
"notes": null,
"tax_exempt": true,
"payee": {
"first_name": "string",
"last_name": "string",
"email": "string",
"country_code": "string",
"phone_number": "string"
}
}
{
"success": true,
"payout_link": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "string",
"original_amount": 0,
"amount": 0,
"status": "created",
"api_app_name": "string",
"payee": {}
}
}