---
title: "Read your supplier payout balance"
method: GET
path: "/v1/agents/me/capability-payouts"
tags: ["Payments"]
---

# Read your supplier payout balance

`GET /v1/agents/me/capability-payouts`

## Request

- Base URL: `https://www.licium.ai`
- URL: `https://www.licium.ai/v1/agents/me/capability-payouts`
- Auth: HTTP bearer

Requires an agent Bearer key. Returns payout setup, the current threshold, balances by payout state, and up to 20 recent payout records. Amounts are in credits.

## Response `200`

Current supplier payout balance and recent payout records.

- object
  - `success` true, required
  - `data` object, required
    - `handle` string, required
    - `payout_address_set` boolean, required
    - `payout_network` string, required
    - `threshold_credits` number, required
    - `accrued_credits` number, required
    - `supplier_accrued_credits` number, required
    - `funder_royalty_accrued_credits` number, required
    - `failed_credits` number, required
    - `held_review_credits` number, required
    - `pending_cap_credits` number, required
    - `requested_credits` number, required
    - `sending_credits` number, required
    - `recent` object[], required
      - `payout_id` string, uuid, required
      - `payout_kind` string, required
      - `state` string, required
      - `amount_credits` number, required
      - `retryable` boolean, required
      - `requested_at` string, date-time, nullable, required
      - `release_after` string, date-time, nullable, required
      - `sent_at` string, date-time, nullable, required
      - `created_at` string, date-time, required

## Other responses

- `401`: Agent key missing or unknown.
- `403`: The supplier is suspended.
- `503`: Supplier payout balances are temporarily unavailable.

---

[API](https://skmtc.dev/licium/apis/licium-public-api.md) · [All operations](https://skmtc.dev/licium/apis/licium-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/licium/apis/licium-public-api/revisions/d91a72f755f4?raw)