POST /api/v1/hosts/payouts
Operation: requestPayout.
Request a payout to an address (host owner; same model as withdrawals)
Payout intent locked against payable, to a saved address, or parked until the emailed link confirms a new one. Sessions confirm with code (POST /api/v1/withdrawals/code with kind=payout, or the authenticator); API keys reach saved addresses only.
Endpoint
Section titled “Endpoint”POST https://amplerun-api.spiry.org/api/v1/hosts/payouts
Authentication
Section titled “Authentication”Use the credential and scope required by this operation. For programmatic renter/host calls: Authorization: Bearer $AMPLERUN_API_KEY. A host-agent signature or other specialized proof is required where the description specifies it.
Parameters
Section titled “Parameters”| Name | Location | Presence | Type | Description |
|---|---|---|---|---|
Idempotency-Key | header | Required | UUID | UUID scoped to authenticated principal, route and canonical request hash. |
Request body
Section titled “Request body”Required body.
application/json
Section titled “application/json”| Field | Type | Presence | Description |
|---|---|---|---|
network | “base” | Optional | Defaults to base. |
address | EvmAddress | Required | |
amount_micro | MicroAmount | Required | |
asset | “USDC” / “USDT” | Optional | Defaults to USDC. |
label | string | Optional | Saved with a new address. |
code | string | Optional | |
siwe_message | string | Optional | |
signature | string | Optional |
{ "$ref": "#/components/schemas/TransferRequest"}Responses
Section titled “Responses”Queued, or waiting for the email link.
application/json
| Field | Type | Presence | Description |
|---|---|---|---|
state | “INTENT” / “AWAITING_EMAIL_CONFIRMATION” | Required | |
withdrawal_id | UUID | Optional | |
payout_id | UUID | Optional | |
confirmation_id | UUID | Optional | |
address_id | UUID | Required | |
expires_at | Rfc3339Utc | Optional | |
asset | “USDC” / “USDT” | Required |
{ "$ref": "#/components/schemas/TransferAccepted"}default
Section titled “default”Error envelope. 401 unauthenticated, 403/404 forbidden, 409 conflict, 422 invalid input, 429 rate limited (code UNAVAILABLE, retryable:true, no Retry-After header), 503 unavailable money/provider state with retryable:true.
application/json
| Field | Type | Presence | Description |
|---|---|---|---|
error | object | Required |
{ "$ref": "#/components/schemas/ErrorEnvelope"}Static request outline
Section titled “Static request outline”Replace path/query placeholders and provide the required JSON body, headers and credential from the sections above. This is a request outline, not a command that chooses an amount or starts a rental for you.
curl --request POST 'https://amplerun-api.spiry.org/api/v1/hosts/payouts' \ --header "Authorization: Bearer $AMPLERUN_API_KEY"Schema definitions · Download OpenAPI · Authentication · Errors and recovery
Official AmpleRun documentation · Contract v3 · Generated from the API contract · Revision 52fe29de · Open AmpleRun · View Markdown · For agents