A payout is a transfer of funds from your account to a user. The easiest way to send a payout is through a Payout Link.

A Payout Link is a link that allows a user to onboard onto Dots and withdraw their funds through their method of choice.

​

Method

1. Create an App
2. Create a Payout Link
3. Send the user to the Payout Link

​

1. Create an App

If you haven’t already, create an account at https://senddotssandbox.com and head over to the Developer tab to create an App.

​

2. Create a Payout Link

We will create a Payout Link for a user whose phone number is known with US $10.

​

Request

Please replace the phone number with your own.

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

​

Response

{
  "success": true,
  "payout_link": {
    "id": "844ebf2b-b968-47ce-99cd-9daeeaa2adbb",
    "link": "https://senddotssandbox.com/payout_link/dsfijw324dqwexfnuishgsdfs",
    "amount": 1000,
    "original_amount": 1000,
    "status": "delivered",
    "payee": {
      "country_code": "1",
      "phone_number": "2025550139",
      "first_name": null,
      "last_name": null,
      "email": null
    }
  }
}

​

3. Send the user to the Payout Link

The link can now be sent to any user in any method and can only be claimed through a text message code sent to the phone number. Please navigate to the link and claim it!