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

Response

200 - application/json

OK

The payout-link object.