Create Payout
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0,
"platform": "<platform>",
"user_id": "<user_id>"
}'
{
"amount": "number",
"created": "string",
"external_data": {
"account_id": "string",
"external_id": "string",
"platform": "ach"
},
"id": "string",
"metadata": [
"string",
"object",
"null"
],
"status": "created",
"transactions": [
{
"amount": "number",
"created": "string",
"destination_name": "string",
"id": "integer",
"metadata": [
"string",
"object",
"null"
],
"source_name": "string"
}
],
"type": "refill",
"user_id": "string"
}
Authorizations
Basic authentication header of the form Basic <encoded-value>
, where <encoded-value>
is the base64-encoded string username:password
.
Body
The bank account ID you are paying to. Required for ach
and intl_bank
.
Amount in cents to payout the user.
Creates a transfer for the amount to the user before creating the payout. The funds are returned if the payout does not succeed.
UUID that will be used to idempotently handle requests. Transfers with existing idempotency keys will be rejected.
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.
Platform that you are paying out the user
through,
paypal
, venmo
, ach
, bank_transfer
, cash_app
, default
ID of the user
who you are creating the payout for.
Response
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.
created
, pending
, failed
, completed
, flagged
refill
, payout
, balance
curl --request POST \
--url https://api.senddotssandbox.com/api/v2/payouts \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"amount": 0,
"platform": "<platform>",
"user_id": "<user_id>"
}'
{
"amount": "number",
"created": "string",
"external_data": {
"account_id": "string",
"external_id": "string",
"platform": "ach"
},
"id": "string",
"metadata": [
"string",
"object",
"null"
],
"status": "created",
"transactions": [
{
"amount": "number",
"created": "string",
"destination_name": "string",
"id": "integer",
"metadata": [
"string",
"object",
"null"
],
"source_name": "string"
}
],
"type": "refill",
"user_id": "string"
}