Request Payout
curl --request POST \
--url https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 25,
"payout_details": "PayPal: affiliate@example.com"
}
'import requests
url = "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request"
payload = {
"amount": 25,
"payout_details": "PayPal: affiliate@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 25, payout_details: 'PayPal: affiliate@example.com'})
};
fetch('https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 25,
'payout_details' => 'PayPal: affiliate@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request"
payload := strings.NewReader("{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payout requested. The seller has been notified."
}{
"message": "Affiliate payouts are not available on this shop."
}{
"message": "The payout could not be requested. Check your affiliate balance and make sure you have no other open payout request."
}Affiliate
Request Payout
Requests a payout of affiliate earnings. The amount leaves the affiliate wallet immediately and is returned if the request is cancelled or rejected. Only available on shops that keep affiliate earnings in a separate balance and have payouts enabled. A customer may hold only one open request at a time.
POST
/
v1
/
customer-dashboard
/
affiliate
/
payout-request
Request Payout
curl --request POST \
--url https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 25,
"payout_details": "PayPal: affiliate@example.com"
}
'import requests
url = "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request"
payload = {
"amount": 25,
"payout_details": "PayPal: affiliate@example.com"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({amount: 25, payout_details: 'PayPal: affiliate@example.com'})
};
fetch('https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 25,
'payout_details' => 'PayPal: affiliate@example.com'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request"
payload := strings.NewReader("{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.sellauth.com/v1/customer-dashboard/affiliate/payout-request")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 25,\n \"payout_details\": \"PayPal: affiliate@example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payout requested. The seller has been notified."
}{
"message": "Affiliate payouts are not available on this shop."
}{
"message": "The payout could not be requested. Check your affiliate balance and make sure you have no other open payout request."
}Authorizations
Authenticate with a customer token, minted server-to-server with POST /v1/shops/{shopId}/customers/{customerId}/token and sent as a Bearer token. Reseller API keys are rejected with a 403 here.
Body
application/json
Amount in USD. Must be at least the shop's minimum payout amount and no more than the affiliate balance.
Example:
25
How the seller should pay out, for example a PayPal address or wallet address. Max 2000 characters.
Example:
"PayPal: affiliate@example.com"