Skip to main content
GET
/
v1
/
admin
/
partners
/
payouts
List pending payouts
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/payouts
import requests

url = "http://localhost:3000/v1/admin/partners/payouts"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('http://localhost:3000/v1/admin/partners/payouts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/v1/admin/partners/payouts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$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 := "http://localhost:3000/v1/admin/partners/payouts"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("http://localhost:3000/v1/admin/partners/payouts")
.asString();
require 'uri'
require 'net/http'

url = URI("http://localhost:3000/v1/admin/partners/payouts")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "payouts": [
    {
      "partner_brand_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "company_name": "<string>",
      "contact_email": "<string>",
      "payout_method": "<string>",
      "sale_count": 123,
      "total_units": 123,
      "gross_sales": 123,
      "total_commission": 123,
      "amount_due": 123,
      "oldest_sale": "2023-11-07T05:31:56Z",
      "newest_sale": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123,
  "summary": {
    "total_partners": 123,
    "total_pending": 123,
    "total_commission": 123
  }
}
{
"error": "<string>",
"message": "<string>"
}

Query Parameters

limit
integer
default:50
Required range: 1 <= x <= 100
offset
integer | null
default:0
Required range: x >= 0
min_amount
number | null
Required range: x >= 0

Response

Payout summaries

payouts
object[]
required
total
number
required
summary
object
required