Read a node-signed payout report.
Operator payout report for one node. The query is signed by the node Ed25519 identity with message `b3iq-node-payout-report-v1:<node_id>:<window_days>:<limit>:<signed_at>:<nonce>`. The response omits customer IDs and credentials.
GET
/v1/nodes/{node_id}/payouts
Operator payout report for one node. The query is signed by the node
Ed25519 identity with message
`b3iq-node-payout-report-v1:<node_id>:<window_days>:<limit>:<signed_at>:<nonce>`.
The response omits customer IDs and credentials.
Path Parameters
node_id
string
required
path
Query Parameters
window_days
integer
optional
query
limit
integer
optional
query
signed_at
string (date-time)
required
query
nonce
string
required
query
signature_ed25519
string
required
query
Responses
200
Node payout report.
application/jsonstatus
string
Enum:
oknode_id
string
generated_at
string (date-time)
summary
object
total_payout_wei
string
settlement_statuses
object[]
Array of:
settlement_status
string
payout_count
integer
total_payout_wei
string
total_amount_wei
string
payouts
object[]
Array of:
entry_id
string
private_job_id
string
receipt_hash
string
amount_wei
string
status
string
settlement_status
string
payout_batch_id
string
settled_at
string (date-time)
created_at
string (date-time)
updated_at
string (date-time)
default
B3IQ-native problem response.
curl -X GET 'https://{controlPlaneHost}/v1/nodes/string/payouts?signed_at=2024-01-01T00%3A00%3A00Z&nonce=string&signature_ed25519=string'const response = await fetch('https://{controlPlaneHost}/v1/nodes/string/payouts?signed_at=2024-01-01T00%3A00%3A00Z&nonce=string&signature_ed25519=string', { method: 'GET'});const data = await response.json();console.log(data);
200
Response
{ "status": "ok", "node_id": "<string>", "generated_at": "2024-01-01T00:00:00Z", "summary": { "total_payout_wei": "<string>", "settlement_statuses": [ { "settlement_status": "<string>", "payout_count": 123, "total_payout_wei": "<string>", "total_amount_wei": "<string>" } ] }, "payouts": [ { "entry_id": "<string>", "private_job_id": "<string>", "receipt_hash": "<string>", "amount_wei": "<string>", "status": "<string>", "settlement_status": "<string>", "payout_batch_id": "<string>", "settled_at": "2024-01-01T00:00:00Z", "created_at": "2024-01-01T00:00:00Z", "updated_at": "2024-01-01T00:00:00Z" } ]}API Playground
Try this endpoint
GET
/v1/nodes/{node_id}/payouts