- Payouts
- Create a Payout
Payouts
Create a Payout
Create a payout for an existing user that has a payout method saved to their account.
POST
/api/v2/payouts
client_id*
api_key*
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"user_id": "string",
"amount": integer,
"platform": "string"
}'Body
user_idRequired
string
ID of the user who you are creating the payout for.
amountRequired
integer
Amount in cents to payout the user.
platformRequired
string
Platform that you are paying out the user through,
Available options:
paypal, venmo, ach, bank_transfer, cash_app, default account_id
string
The bank account ID you are paying to. Required for ach and intl_bank.
fund
boolean
Creates a transfer for the amount to the user before creating the payout. The funds are returned if the payout does not succeed.
idempotency_key
string
UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.
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.
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts \
--header 'Authorization: Basic AUTH_VALUE' \
--header 'Content-Type: application/json' \
--data '{
"user_id": "string",
"amount": integer,
"platform": "string"
}'