Skip to main content
GET
/
v1
/
admin
/
partners
/
payouts
List pending payouts
curl --request GET \
  --url http://localhost:3000/v1/admin/partners/payouts
{
  "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
  }
}

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