Read a provider's scheduled payouts

GET

/provider/payouts/{address}

const url = 'https://api.staging.katara.com/v1/provider/payouts/example';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.staging.katara.com/v1/provider/payouts/example

Replies paid with Katara credits are paid to the provider at scheduled payouts rather than settled one by one. This statement lists what the payout address is owed and every payout cut for it within the last 90 days, each with the receipts it covers. A payout’s key is the settlement key on chain; the node recomputes it from the listed receipts and the fee before it counts the payout. The response contains ticket hashes and amounts only.

Parameters

Path Parameters

address

required

string

/^0x[0-9a-fA-F]{40}$/

Public payout address.

Responses

200

The payout statement. Amounts are USDC base units.

application/json

object

payout

required

string

owed

required

object

replies

required

integer

amount

required

string

oldest

Unix seconds of the oldest owed reply.

integer

fee

required

Payout fee per payout.

string

minimum

required

Smallest amount paid at a run.

string

next_run

required

Unix seconds of the next payout run.

integer

idle_after_seconds

required

Age after which a balance under the minimum is paid if it is at least five times the fee.

integer

payouts

required

Array<object>

object

key

required

string

chain_id

required

integer

settlement

required

string

buyer

required

string

payout

required

string

gross

required

Sum of the receipts.

string

fee

required

string

net

required

Gross less the payout fee; the settled amount.

string

state

required

string

Allowed values: scheduled submitted retrying stuck paid

cut_at

required

Unix milliseconds the payout was cut.

integer

transaction

string

block

integer

members

required

Array<object>

object

ticket

required

string

amount

required

string

Example

{
  "payouts": [
    {
      "state": "scheduled"
    }
  ]
}

400

The address is invalid.

404

This network does not schedule payouts.