POST
/
v2
/
payout-links
Authorization
Body
curl --request POST \
  --url https://api.dots.dev/api/v2/payout-links \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "additional_steps": [
    "compliance"
  ],
  "amount": 123,
  "delivery": {
    "message": "<string>",
    "method": "sms"
  },
  "force_collect_compliance_information": true,
  "idempotency_key": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "memo": "<string>",
  "metadata": "<string>",
  "payee": {
    "country_code": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>"
  },
  "payout_fee_party": "user",
  "tax_exempt": true,
  "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
{
  "amount": 123,
  "claimed_user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "delivery": {
    "country_code": "<string>",
    "email": "jsmith@example.com",
    "method": "link",
    "phone_number": "<string>"
  },
  "flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "link": "<string>",
  "metadata": "<string>",
  "payee": {
    "country_code": "<string>",
    "email": "jsmith@example.com",
    "first_name": "<string>",
    "last_name": "<string>",
    "phone_number": "<string>"
  },
  "status": "sent",
  "tax_exempt": true
}

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
additional_steps
enum<string>[]

Array of steps in the flow.

Available options:
compliance,
id-verification,
background-check,
manage-payments,
manage-payouts,
payout,
redirect
amount
integer
required

Amount to be paid in cents.

delivery
object
force_collect_compliance_information
boolean
default: false

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

idempotency_key
string | 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.

memo
string

Add a memo to the top of the 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.

payee
object

The payee. This is optional.

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

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

user_id
string

The user's id.

Response

200 - application/json
amount
number

The amount to pay in cents.

claimed_user_id
string

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

created
string

Date the payout-link was created.

delivery
object
flow_id
string

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

id
string

ID of the payout-link.

link
string

URL to access the 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.

payee
object

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

status
enum<string>

Status of the payout-link.

Available options:
sent,
claimed,
delivery_pending,
delivery_failed,
delivered,
canceled
tax_exempt
boolean

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

Get Payout LinksGet Payout Link by ID