Affiliate Payment Request

Issuing a payment request to the app, on behalf of the affiliate.

POST https://platform.shoffi.app/API/affiliate/requestPayment

You can use this API to let affiliates request payments directly from your app/website if they have already earned more than the minimum withdrawal amount.

Request Body

Name	Type	Description
apiKey*	String	Your Shoffi app API Key
appId*	Integer	Your app ID
paypalEmail*	String	The PayPal email account of the affiliate
email*	String	The affiliate email address

200: OK

{
    "affiliateNewTerms": {
        "revenueShare": 50,
        "cpi": 10,
        "limitPeriod": 24,
        "minWithdrawal": 50
    }
}

400: Bad Request

{
    "status": 400,
    "message": "Error details"
}

curl -X POST 'https://platform.shoffi.app/API/affiliate/requestPayment' \
-H 'Content-Type: application/json' \
-d '{
    "apiKey": "YourKey",
    "appId": 00000000,
    "affiliateDetails": {
        "email": "[email protected]",
        "paypalEmail": "[email protected]"
    }
}'

Please Note! Some affiliates already added their PayPal email account to Shoffi. In that case, the PayPal account will remain the old one, and not the one you have sent in in the request.

You can see the final PayPal email account in the response data.

Response example

200 OK
Content-Type: application/json

{
    "affiliateDetails": {
        "email": "[email protected]",
        "firstName": "Tobias",
        "lastName": "Lütke",
        "nickName": "tobi"
    },
    "affiliatePerformance": {
        "appProfit": 39.8,
        "affiliateProfit": "7.96",
        "paidToAffiliate": 0,
        "linkViews": 3
    },
    "paypalAddress": "[email protected]"
}