Skip to main content
Send a Payout
curl --request POST \
  --url https://api.dots.dev/api/v2/payouts/send-payout \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": 123,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payee": {
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "delivery": {
    "message": "<string>"
  },
  "force_collect_compliance_information": false,
  "additional_steps": [
    "compliance"
  ],
  "tax_exempt": true,
  "metadata": "<string>",
  "memo": "<string>",
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payout_fee_party": "user",
  "accounting_data": {
    "quickbooks_account_id": 123,
    "quickbooks_class_id": 123
  }
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "link": "<string>",
  "amount": 123,
  "status": "created",
  "payee": {
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "delivery": {
    "method": "link",
    "email": "jsmith@example.com",
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "tax_exempt": true,
  "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "transfer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "metadata": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
amount
integer
required

The amount in cents to pay the user.

Required range: x > 0
​
user_id
string<uuid>

The user's id. user_id or payee is required.

​
payee
object

The payee's phone number. user_id or payee is required.

​
delivery
object
​
force_collect_compliance_information
boolean
default:false

Collect 1099 or w8-ben information.

​
additional_steps
enum<string>[]

Array of steps in the flow.

​
tax_exempt
boolean

Payouts marked as tax_exempt will not be counted towards the 1099 threshold.

​
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.

​
memo
string

Add a memo to the top of the Payout Link

​
idempotency_key
string<uuid> | null

Unique UUID key that prevents duplicate requests from being processed. If a payout link with the idempotency key exists, a new link will not be created and the existing link will be returned instead.

​
payout_fee_party
enum<string> | null

Overrides the setting for which party will pay fees on this payout. This takes precedence over the default for your application.

Available options:
user,
platform
​
accounting_data
object

Response

201 - application/json

Created

The payout-link object.

​
id
string<uuid>

ID of the payout-link.

​
created
string<date-time>

Date the payout-link was created.

​
link
string<uri>

URL to access the payout-link.

​
amount
number

The amount to pay in cents.

​
status
enum<string>

Status of the payout-link.

Available options:
created,
delivery_pending,
delivery_failed,
sent,
delivered,
claimed,
reversed,
canceled,
expired
​
payee
object

Information about the payee. It is used to pre-fill information.

​
delivery
object
​
tax_exempt
boolean

Transfers marked as tax_exempt will not be counted towards the 1099 threshold.

​
claimed_user_id
string<uuid>

ID of the user that has claimed the payout-link.

​
flow_id
string<uuid>

ID of the payout flow UI that is sent to the user.

​
transfer_id
string<uuid>

ID of the transfer created for this payout-link.

​
memo
string | null

Optional memo added to this payout-link

​
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.

⌘I