Dots home pagelight logo
  1. Payouts
  2. Create a Payout Link

info

All requests to the /v2/payouts/* endpoints must include both the client_id and api_key as detailed in the Authentication document.

A Payout Link is the easiest way to initiate a payout. The link does not need to be tied to a user and can be delivered via email or SMS. Once the link is claimed, the user will be able to pay themselves out in any method they choose.

​
Payout Link with Minimal Information

​
Method

Make a request to the /v2/payouts/create_payout_link endpoint

curl https://pls.senddotssandbox.com/v2/payouts/create_payout_link \
  -X POST \
  -H "Authorization: Basic <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "delivery": {
            "method": "link"
        }
        "amount": 1000,
      }'

response = {
    "success": true,
    "payout_link": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "link": "https://senddotssandbox.com/payout_link/dsfvytoehf3745bfm2k3244543fdf",
      "original_amount": 1000,
      "amount": 1000,
      "status": "delivered",
      "api_app_name": "Test App",
      "payee": {
        "first_name": null,
        "last_name": null,
        "email": null,
        "country_code": null,
        "phone_number": null
      }
    }
  }

​
Payout Link with Payee Information

​
Method

Make a request to the /v2/payouts/create_payout_link endpoint

curl https://pls.senddotssandbox.com/v2/payouts/create_payout_link \
  -X POST \
  -H "Authorization: Basic <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "delivery": {
            "method": "link"
        }
        "amount": 1000,
        "payee": {
            "first_name": "John",
            "last_name": "Doe",
            "country_code": "1",
            "phone_number": "5555555555"
        }
      }'

response = {
    "success": true,
    "payout_link": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "link": "https://senddotssandbox.com/payout_link/dsfvytoehf3745bfm2k3244543fdf",
      "original_amount": 1000,
      "amount": 1000,
      "status": "delivered",
      "api_app_name": "Test App",
      "payee": {
        "first_name": "John",
        "last_name": "Doe",
        "email": null,
        "country_code": "1",
        "phone_number": "5555555555"
      }
    }
  }