Dots home pagelight logo
  1. Payouts
  2. Create an iFrame Payout

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

To create an iFrame payout, a link must be generated and shown to the user via iframe or webview. The link will be valid for 15 minutes after API response.

​
Generate a Link

​
Method

Make a request to the /v2/users/wallet/payout endpoint

curl https://pls.senddotssandbox.com/v2/users/wallet/payout \
  -X POST \
  -H "Authorization: Basic <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
        "user_id": "8732b0e5-8d47-4be7-839f-5cdecbe2df99"
      }'

response = {
    "success": true,
    "link": "https://senddotssandbox.com/payout/Bug3toxuH6QCv9au820z5iZPfmQvZohAvMaNrpIASGXzk9asgkldjla"
  }

​
Styling

The contents of the link can be styled through URL variables. The variables can be appended to the end of the link. For example:

https://senddotssandbox.com/payout/Bug3toxuH6QCv9au820z5iZPfmQvZohAvMaNrpIASGXzk9asgkldjla?iframe=true&bgColor=000000&textColor=ffffff

The available variables are:

VariableDescription
iframeIf set to true, the link will be rendered for use in an iframe
bgColorThe background color of the iframe. Set as hex code without the #. eg. 000000
textColorThe text color of the iframe. Set as hex code without the #. eg. ffffff
darkModeIf set to true of the bgColor is ‘dark’.