Create a Payout Link
users
transfers
payout-links
payments
payment-intents
payment-customers
checkout-sessions
accounts-payable
- GETList all vendors
- POSTCreate a vendor
- GETGet vendor details
- DELDelete a vendor
- GETList all payment methods for a vendor
- POSTCreate a payment method for a vendor
- GETGet vendor payment method details
- DELDelete a vendor payment method
- GETList all payables
- POSTCreate a payable
- POSTCreate a payable from a file
- GETGet payable details
- PATCHUpdate a payable
- POSTUpload file to the payable
- DELDelete file from the payable
- POSTCancel a payable
- POSTSubmit a payable for approval
- POSTApprove a payable
- POSTReject a payable
- POSTPay a payable
- GETList all approval policies
- POSTCreate an approval policy
- DELDelete an approval policy
- PATCHUpdate priority of an approval policy
- GETList all approvers for api app
apps
- GETList all Apps
- POSTCreate an App
- GETRetrieve an App
- GETRetrieve an App's Compliance Information
- PUTUpdate an App's Compliance Information
- GETGet App ACH Account
- PUTAdd App ACH Account
- POSTDeposit Funds into App Wallet
- POSTWithdraw Funds From App Wallet
- POSTRefresh compliance flow
- POSTUpdate an application's settings
payment-methods
Create a Payout Link
All requests to the /v2/payouts/* endpoints must include both the clientid and apikey as detailed in the Authentication document.
info
All requests to the /v2/payouts/*
endpoints must include both the client_id
and api_key
as detailed in the Authentication document.
A Payout Link is the easiest way to initiate a payout. The link does not need to be tied to a user and can be delivered via email or SMS. Once the link is claimed, the user will be able to pay themselves out in any method they choose.
Payout Link with Minimal Information
Method
Make a request to the /v2/payouts/create_payout_link endpoint
curl https://pls.senddotssandbox.com/v2/payouts/create_payout_link \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"delivery": {
"method": "link"
}
"amount": 1000,
}'
response = {
"success": true,
"payout_link": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "https://senddotssandbox.com/payout_link/dsfvytoehf3745bfm2k3244543fdf",
"original_amount": 1000,
"amount": 1000,
"status": "delivered",
"api_app_name": "Test App",
"payee": {
"first_name": null,
"last_name": null,
"email": null,
"country_code": null,
"phone_number": null
}
}
}
Payout Link with Payee Information
Method
Make a request to the /v2/payouts/create_payout_link endpoint
curl https://pls.senddotssandbox.com/v2/payouts/create_payout_link \
-X POST \
-H "Authorization: Basic <TOKEN>" \
-H "Content-Type: application/json" \
-d '{
"delivery": {
"method": "link"
}
"amount": 1000,
"payee": {
"first_name": "John",
"last_name": "Doe",
"country_code": "1",
"phone_number": "5555555555"
}
}'
response = {
"success": true,
"payout_link": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"link": "https://senddotssandbox.com/payout_link/dsfvytoehf3745bfm2k3244543fdf",
"original_amount": 1000,
"amount": 1000,
"status": "delivered",
"api_app_name": "Test App",
"payee": {
"first_name": "John",
"last_name": "Doe",
"email": null,
"country_code": "1",
"phone_number": "5555555555"
}
}
}
Was this page helpful?