Earnings
What a party has earned, its payouts, and where they are sent.
| Operation | Request |
|---|---|
| Read exact private earnings, obligations, destinations, and payout states; limit 1–200, after_earning and after_payout exclusive cursors | GET /v1/earnings/{party} |
| Read the account setting, effective source, and owner rail qualification reference | GET /v1/earnings/{party}/destination |
| Compare and replace a mainnet account fallback with expected_version and value. Signed sources and reserved attempts stay pinned | PUT /v1/earnings/{party}/destination |
| Download one bounded private JSON statement page; no payer aliases, invoices, payment hashes, raw wallet errors, or resource queries | GET /v1/earnings/{party}/export |
| Read this payee’s journaled attempt and same-reference reconciliation link; no send or retry | GET /v1/earnings/{party}/payouts/{payout} |
Read exact private earnings, obligations, destinations, and payout states; limit 1–200, after_earning and after_payout exclusive cursors
GET /v1/earnings/{party} · get-v1-earnings--party-
Earnings configuration and current account/payee/workspace authorization are required. Responses are private and never send payments.
Sign-in: a bearer credential in the Authorization header.
bearer: An issued key: oak_<id>.<secret>. Omitted entirely for anonymous access to shared doors, which a require_workspace_membership deployment refuses outright.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | No | |
after_earning | query | integer | No | |
after_payout | query | integer | No |
Response
200 — Authorized private earnings view.
Errors
| Status | Meaning | Body |
|---|---|---|
| 400, 401, 403, 409, 413, 503 | A typed refusal — see the | TypedError |
Example
curl 'https://api.openagents.com/v1/earnings/{party}' \
-H "Authorization: Bearer $OPENAGENTS_TOKEN"
Read the account setting, effective source, and owner rail qualification reference
GET /v1/earnings/{party}/destination · get-v1-earnings--party--destination
Earnings configuration and current account/payee/workspace authorization are required. Responses are private and never send payments.
Sign-in: a bearer credential in the Authorization header.
bearer: An issued key: oak_<id>.<secret>. Omitted entirely for anonymous access to shared doors, which a require_workspace_membership deployment refuses outright.
Response
200 — Authorized private earnings view.
Errors
| Status | Meaning | Body |
|---|---|---|
| 400, 401, 403, 409, 413, 503 | A typed refusal — see the | TypedError |
Example
curl 'https://api.openagents.com/v1/earnings/{party}/destination' \
-H "Authorization: Bearer $OPENAGENTS_TOKEN"
Compare and replace a mainnet account fallback with expected_version and value. Signed sources and reserved attempts stay pinned
PUT /v1/earnings/{party}/destination · put-v1-earnings--party--destination
Earnings configuration and current account/payee/workspace authorization are required. Responses are private and never send payments.
Sign-in: a bearer credential in the Authorization header.
bearer: An issued key: oak_<id>.<secret>. Omitted entirely for anonymous access to shared doors, which a require_workspace_membership deployment refuses outright.
Request body
Content type: application/json
Type: object
| Field | Type | Required | Description |
|---|---|---|---|
expected_version | integer | Yes | |
value | string | Yes |
Response
200 — Authorized private earnings view.
Errors
| Status | Meaning | Body |
|---|---|---|
| 400, 401, 403, 409, 413, 503 | A typed refusal — see the | TypedError |
Example
curl -X PUT 'https://api.openagents.com/v1/earnings/{party}/destination' \
-H "Authorization: Bearer $OPENAGENTS_TOKEN" \
-H 'Content-Type: application/json' \
-d '{
"expected_version": 0,
"value": "string"
}'
Download one bounded private JSON statement page; no payer aliases, invoices, payment hashes, raw wallet errors, or resource queries
GET /v1/earnings/{party}/export · get-v1-earnings--party--export
Earnings configuration and current account/payee/workspace authorization are required. Responses are private and never send payments.
Sign-in: a bearer credential in the Authorization header.
bearer: An issued key: oak_<id>.<secret>. Omitted entirely for anonymous access to shared doors, which a require_workspace_membership deployment refuses outright.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer | No | |
after_earning | query | integer | No | |
after_payout | query | integer | No |
Response
200 — Authorized private earnings view.
Errors
| Status | Meaning | Body |
|---|---|---|
| 400, 401, 403, 409, 413, 503 | A typed refusal — see the | TypedError |
Example
curl 'https://api.openagents.com/v1/earnings/{party}/export' \
-H "Authorization: Bearer $OPENAGENTS_TOKEN"
Read this payee’s journaled attempt and same-reference reconciliation link; no send or retry
GET /v1/earnings/{party}/payouts/{payout} · get-v1-earnings--party--payouts--payout-
Earnings configuration and current account/payee/workspace authorization are required. Responses are private and never send payments.
Sign-in: a bearer credential in the Authorization header.
bearer: An issued key: oak_<id>.<secret>. Omitted entirely for anonymous access to shared doors, which a require_workspace_membership deployment refuses outright.
Response
200 — Authorized private earnings view.
Errors
| Status | Meaning | Body |
|---|---|---|
| 400, 401, 403, 404, 409, 413, 503 | A typed refusal — see the | TypedError |
Example
curl 'https://api.openagents.com/v1/earnings/{party}/payouts/{payout}' \
-H "Authorization: Bearer $OPENAGENTS_TOKEN"