- Payout Requests
- Create a Payout Request
Payout Requests
Create a Payout Request
Submit a payout request from a person when you know their phone number or user id. Once the payout request is approved, they will be sent a Payout Link to onboard and recieve funds.
POST
/api/v2/payout-requests
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payout-requests \
--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.
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 payout request
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payout-requests \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"amount": integer
}'