Create a Payout Link

Create a Payout Link.

POST /v2/payout-links

Create a Payout Link

cURL

curl --request POST \
  --url https://api.dots.dev/api/v2/payout-links \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payee": {
    "first_name": "<string>",
    "last_name": "<string>",
    "country_code": "<string>",
    "phone_number": "<string>",
    "email": "<string>"
  },
  "delivery": {
    "message": "<string>"
  },
  "force_collect_compliance_information": false,
  "tax_exempt": true,
  "metadata": "<string>",
  "memo": "<string>",
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "additional_steps": [],
  "accounting_data": {
    "quickbooks_account_id": 123,
    "quickbooks_class_id": 123
  },
  "hide_go_to_dashboard_on_complete": false,
  "description": "<string>"
}
'

import requests

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

payload = {
    "amount": 123,
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "payee": {
        "first_name": "<string>",
        "last_name": "<string>",
        "country_code": "<string>",
        "phone_number": "<string>",
        "email": "<string>"
    },
    "delivery": { "message": "<string>" },
    "force_collect_compliance_information": False,
    "tax_exempt": True,
    "metadata": "<string>",
    "memo": "<string>",
    "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "additional_steps": [],
    "accounting_data": {
        "quickbooks_account_id": 123,
        "quickbooks_class_id": 123
    },
    "hide_go_to_dashboard_on_complete": False,
    "description": "<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',
    payee: {
      first_name: '<string>',
      last_name: '<string>',
      country_code: '<string>',
      phone_number: '<string>',
      email: '<string>'
    },
    delivery: {message: '<string>'},
    force_collect_compliance_information: false,
    tax_exempt: true,
    metadata: '<string>',
    memo: '<string>',
    idempotency_key: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    additional_steps: [],
    accounting_data: {quickbooks_account_id: 123, quickbooks_class_id: 123},
    hide_go_to_dashboard_on_complete: false,
    description: '<string>'
  })
};

fetch('https://api.dots.dev/api/v2/payout-links', 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-links",
  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',
    'payee' => [
        'first_name' => '<string>',
        'last_name' => '<string>',
        'country_code' => '<string>',
        'phone_number' => '<string>',
        'email' => '<string>'
    ],
    'delivery' => [
        'message' => '<string>'
    ],
    'force_collect_compliance_information' => false,
    'tax_exempt' => true,
    'metadata' => '<string>',
    'memo' => '<string>',
    'idempotency_key' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'additional_steps' => [
        
    ],
    'accounting_data' => [
        'quickbooks_account_id' => 123,
        'quickbooks_class_id' => 123
    ],
    'hide_go_to_dashboard_on_complete' => false,
    'description' => '<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-links"

	payload := strings.NewReader("{\n  \"amount\": 123,\n  \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payee\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone_number\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"delivery\": {\n    \"message\": \"<string>\"\n  },\n  \"force_collect_compliance_information\": false,\n  \"tax_exempt\": true,\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"additional_steps\": [],\n  \"accounting_data\": {\n    \"quickbooks_account_id\": 123,\n    \"quickbooks_class_id\": 123\n  },\n  \"hide_go_to_dashboard_on_complete\": false,\n  \"description\": \"<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-links")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 123,\n  \"user_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"payee\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone_number\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"delivery\": {\n    \"message\": \"<string>\"\n  },\n  \"force_collect_compliance_information\": false,\n  \"tax_exempt\": true,\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"additional_steps\": [],\n  \"accounting_data\": {\n    \"quickbooks_account_id\": 123,\n    \"quickbooks_class_id\": 123\n  },\n  \"hide_go_to_dashboard_on_complete\": false,\n  \"description\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"payee\": {\n    \"first_name\": \"<string>\",\n    \"last_name\": \"<string>\",\n    \"country_code\": \"<string>\",\n    \"phone_number\": \"<string>\",\n    \"email\": \"<string>\"\n  },\n  \"delivery\": {\n    \"message\": \"<string>\"\n  },\n  \"force_collect_compliance_information\": false,\n  \"tax_exempt\": true,\n  \"metadata\": \"<string>\",\n  \"memo\": \"<string>\",\n  \"idempotency_key\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"additional_steps\": [],\n  \"accounting_data\": {\n    \"quickbooks_account_id\": 123,\n    \"quickbooks_class_id\": 123\n  },\n  \"hide_go_to_dashboard_on_complete\": false,\n  \"description\": \"<string>\"\n}"

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

201

{
  "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>",
  "description": "<string>",
  "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,
  "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>",
  "description": "<string>",
  "accounting_data": {
    "quickbooks_account_id": 123,
    "quickbooks_class_id": 123
  }
}

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

Amount to be paid in cents.

user_id · string<uuid>

The user's id.

payee · object

The payee. This is optional.

Show child attributes

delivery · object

Show child attributes

force_collect_compliance_information · boolean · default: false

Force the collection of 1099 or W-8 information. Defaults to false.

tax_exempt · boolean

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

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

additional_steps · (enum<string> | Step With Options · object)[]

Array of steps to add to the payout flow. Each item is either a step-name string or an object with additional step options.

The step name.

Available options: compliance, id-verification, background-check, manage-payments, manage-payouts, payout, redirect, pdf-form-fill

accounting_data · object

Show child attributes

funding_source · enum<string>

The funding source for the payout. If dots_balance is specified, the payout is funded from the app's Dots wallet balance. If ach is specified, the payout is funded via a bank transfer from the app's linked bank account. If not specified, defaults to dots_balance.

Available options: dots_balance, ach

hide_go_to_dashboard_on_complete · boolean · default: false

Hide the "Go to dashboard" button on the payout flow UI. Defaults to false.

description · string

An internal description for the payout-link. Unlike memo, it is not shown to the payee.

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, failed

payee · object

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

Show child attributes

delivery · object

Show child attributes

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

description · string | null

An internal description for the payout-link. Unlike memo, it is not shown to the payee.

accounting_data · object

Accounting metadata synced to external accounting systems.

Show child attributes

funding_source · enum<string>

The funding source used to fund the payout. One of dots_balance or ach.

Available options: dots_balance, ach