hosts

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.

post/api/v1/hosts/payouts

Request

Base URL: https://amplerun-api.spiry.org
URL: https://amplerun-api.spiry.org/api/v1/hosts/payouts
Auth: HTTP bearer

Headers

Idempotency-Keystring uuid required

Example:3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40

UUID scoped to authenticated principal, route and canonical request hash.

Request body

network'base'

Defaults to base.

addressstring required

amount_microstring required

Unsigned base-10 integer as string; never a float.

asset'USDC' | 'USDT'

Defaults to USDC.

labelstring

Saved with a new address.

codestring

siwe_messagestring

signaturestring

Example request

{
  "address": "0x1111111111111111111111111111111111111111",
  "amount_micro": "1"
}

Response

Queued, or waiting for the email link.

state'INTENT' | 'AWAITING_EMAIL_CONFIRMATION' required

withdrawal_idstring uuid

payout_idstring uuid

confirmation_idstring uuid

address_idstring uuid required

expires_atstring date-time

asset'USDC' | 'USDT' required

Example response

{
  "withdrawal_id": "3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40",
  "payout_id": "3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40",
  "confirmation_id": "3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40",
  "address_id": "3f0e2a55-8c1b-4d2e-9a6f-0b7c1d2e3f40",
  "expires_at": "2026-09-25T12:00:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.