curl --request POST \
  --url https://api.dots.dev/api/v2/payouts \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "amount": 123,
  "platform": "paypal",
  "account_id": "<string>",
  "fund": true,
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metadata": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "created",
  "type": "refill",
  "amount": 123,
  "external_data": {
    "account_id": "<string>",
    "external_id": "<string>",
    "platform": "ach"
  },
  "transactions": [
    {
      "id": 123,
      "amount": 123,
      "created": "2023-11-07T05:31:56Z",
      "source_name": "<string>",
      "destination_name": "<string>",
      "type": "balance",
      "metadata": "<string>"
    }
  ],
  "metadata": "<string>"
}

Authorizations

Authorization
string
headerrequired

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

Body

application/json
user_id
string
required

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

amount
integer
required

Amount in cents to payout the user.

platform
enum<string>
required

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

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.

Response

201 - application/json
id
string
created
string
user_id
string
status
enum<string>
Available options:
created,
pending,
failed,
completed,
flagged
type
enum<string>
Available options:
refill,
payout,
balance
amount
number
external_data
object
transactions
object[]
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.