Skip to main content
Create a Payout Request
curl --request POST \
  --url https://api.dots.dev/api/v2/payout-requests \
  --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>"
  },
  "metadata": "<string>",
  "memo": "<string>"
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "amount": 123,
  "status": "created",
  "payee": {
    "country_code": "<string>",
    "phone_number": "<string>"
  },
  "payout-link": {
    "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>"
  },
  "user": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "jsmith@example.com",
    "phone_number": {
      "country_code": "<string>",
      "phone_number": "<string>"
    },
    "default_payout_method": "ach",
    "default_payout_method_details": {
      "id": "<string>",
      "platform": "ach",
      "description": "<string>",
      "mask": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "cash_tag": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "rtp_enabled": true
    },
    "wallet": {
      "amount": 123,
      "withdrawable_amount": 123,
      "credit_balance": 123
    },
    "status": "verified",
    "compliance": {
      "tax_id_collected": true,
      "tax_id_verification": "unsubmitted",
      "address_collected": true,
      "date_of_birth_collected": true,
      "must_collect_1099": true,
      "1099_collected": true,
      "w8_ben_collected": true,
      "flagged": true,
      "id_verified": true,
      "has_criminal_activity": true,
      "w9": "<any>",
      "flags": {
        "ofac": true,
        "ofac_status": "unflagged",
        "payout_method": true,
        "payout_method_cycle": true
      }
    },
    "metadata": "<string>"
  },
  "metadata": "<string>",
  "memo": "<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.

​
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 payout request

Response

201 - application/json

Created

The payout-request id.

​
id
string<uuid>

ID of the payout-request.

​
created
string<date-time>

Date that the payout-request was created.

​
amount
number

Amount in cents of the payout-request.

​
status
enum<string>

Status of the payout-request.

Available options:
created,
approved,
rejected
​
payee
object
​
payout-link
object

The payout-link that was sent when the payout-request was approved.

​
user
object

The user that requested the payout.

​
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