Create a Payout Request

Submit a payout request from a person when you know their phone number or user id. Once the payout request is approved, they will be sent a Payout Link to onboard and recieve funds.

POST /v2/payout-requests

Create a Payout Request

cURL

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",
  "metadata": "<string>",
  "memo": "<string>"
}
'

import requests

url = "https://api.dots.dev/api/v2/payout-requests"

payload = {
    "amount": 123,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadata": "<string>",
    "memo": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 123,
    user_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    metadata: '<string>',
    memo: '<string>'
  })
};

fetch('https://api.dots.dev/api/v2/payout-requests', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.dots.dev/api/v2/payout-requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 123,
    'user_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'metadata' => '<string>',
    'memo' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.dots.dev/api/v2/payout-requests"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Basic <encoded-value>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.dots.dev/api/v2/payout-requests")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dots.dev/api/v2/payout-requests")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 123,\n  \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "amount": 123,
  "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,
    "payee": {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "[e-mail]",
      "country_code": "<string>",
      "phone_number": "<string>"
    },
    "delivery": {
      "email": "[e-mail]",
      "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": "[e-mail]",
    "phone_number": {
      "country_code": "<string>",
      "phone_number": "<string>"
    },
    "default_payout_method_details": {
      "id": "<string>",
      "description": "<string>",
      "mask": "<string>",
      "email": "<string>",
      "phone_number": "<string>",
      "cash_tag": "<string>",
      "country": "<string>",
      "currency": "<string>",
      "rtp_enabled": true,
      "meta": "<unknown>"
    },
    "wallet": {
      "amount": 123,
      "withdrawable_amount": 123,
      "credit_balance": 123
    },
    "compliance": {
      "tax_id_collected": true,
      "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,
      "background_check": {
        "updated": "2023-11-07T05:31:56Z"
      },
      "w9": {
        "business_name": "<string>",
        "tax_id_collected": true,
        "address_collected": true
      },
      "flags": {
        "ofac": true,
        "payout_method": true,
        "payout_method_cycle": true,
        "name_mismatch": true
      }
    },
    "metadata": "<string>",
    "payout_options_exclude_list": []
  },
  "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.

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.

Show child attributes

metadata · string object

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

Show child attributes

payout-link · object

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

Show child attributes

user · object

The user that requested the payout.

Show child attributes

metadata · string object

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