POST
/
v2
/
payouts
Authorization
Body
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

Authorizationheaderrequired
string

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
account_id
string

The bank account ID you are paying to. Required for ach and intl_bank.

amountrequired
integer

Amount in cents to payout the user.

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

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.

platformrequired
enum<string>

Platform that you are paying out the user through,

Available options:
paypal,
venmo,
ach,
bank_transfer,
cash_app,
default
user_idrequired
string

ID of the user who you are creating the payout for.

Response

201 - application/json
amount
number
created
string
external_data
object
id
string
metadata

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.

status
enum<string>
Available options:
created,
pending,
failed,
completed,
flagged
transactions
object[]
type
enum<string>
Available options:
refill,
payout,
balance
user_id
string
Send a PayoutPayout Links Overview