List payouts
curl --request GET \
--url https://app.papelship.com/api/v1/affiliates/payouts \
--header 'x-api-key: <api-key>' \
--header 'x-store-hash: <api-key>'const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-store-hash': '<api-key>'}
};
fetch('https://app.papelship.com/api/v1/affiliates/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.papelship.com/api/v1/affiliates/payouts"
headers = {
"x-api-key": "<api-key>",
"x-store-hash": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.papelship.com/api/v1/affiliates/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-store-hash: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.papelship.com/api/v1/affiliates/payouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-store-hash", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"payouts": [
{
"id": "<string>",
"amount": 123,
"currency": "<string>",
"method": "crypto",
"coin": "<string>",
"network": "<string>",
"address": "<string>",
"details": "<string>",
"amount_coin": 123,
"quote_at": "2026-10-04T12:00:00.000Z",
"tx_hash": "<string>",
"tx_verified": true,
"reference": "<string>",
"status": "requested",
"requested_at": "2026-10-04T12:00:00.000Z",
"approved_at": "2026-10-04T12:00:00.000Z",
"sent_at": "2026-10-04T12:00:00.000Z",
"note": "<string>",
"partner": {
"id": "7fKq2LmN9xPa3RtB",
"email": "<string>",
"name": "<string>"
},
"partner_available": 123
}
],
"next_cursor": 123,
"counts": {}
}Affiliates
List payouts
Needs the affiliate programme (FEATURE_NOT_ENABLED otherwise). 25 per page, cursor based. Open requests first. Approving and sending stay in the dashboard.
Permission: affiliates:read
GET
/
affiliates
/
payouts
List payouts
curl --request GET \
--url https://app.papelship.com/api/v1/affiliates/payouts \
--header 'x-api-key: <api-key>' \
--header 'x-store-hash: <api-key>'const options = {
method: 'GET',
headers: {'x-api-key': '<api-key>', 'x-store-hash': '<api-key>'}
};
fetch('https://app.papelship.com/api/v1/affiliates/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://app.papelship.com/api/v1/affiliates/payouts"
headers = {
"x-api-key": "<api-key>",
"x-store-hash": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.papelship.com/api/v1/affiliates/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>",
"x-store-hash: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://app.papelship.com/api/v1/affiliates/payouts"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("x-store-hash", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}{
"success": true,
"payouts": [
{
"id": "<string>",
"amount": 123,
"currency": "<string>",
"method": "crypto",
"coin": "<string>",
"network": "<string>",
"address": "<string>",
"details": "<string>",
"amount_coin": 123,
"quote_at": "2026-10-04T12:00:00.000Z",
"tx_hash": "<string>",
"tx_verified": true,
"reference": "<string>",
"status": "requested",
"requested_at": "2026-10-04T12:00:00.000Z",
"approved_at": "2026-10-04T12:00:00.000Z",
"sent_at": "2026-10-04T12:00:00.000Z",
"note": "<string>",
"partner": {
"id": "7fKq2LmN9xPa3RtB",
"email": "<string>",
"name": "<string>"
},
"partner_available": 123
}
],
"next_cursor": 123,
"counts": {}
}Yetkilendirmeler
Your Store API key (pk_live_...). Create it in Developers › API keys.
The ID of the store the request is for. Shown in Developers › API keys.
Sorgu Parametreleri
Mevcut seçenekler:
open, requested, approved, sent, failed, cancelled next_cursor from the previous page.