POST /api/v1/withdrawals/code

Operation: sendWithdrawalCode.

Email a 6-digit code for one withdrawal or payout (session, no 2FA)

Bound to kind, network, address, amount and asset; 10 minutes, 5 tries, single use, 5 per hour. 409 for 2FA accounts (use the authenticator).

Endpoint

POST https://amplerun-api.spiry.org/api/v1/withdrawals/code

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.

Request body

Required body.

application/json

Field	Type	Presence	Description
kind	“withdrawal” / “payout”	Required
network	“base”	Optional
address	EvmAddress	Required
amount_micro	MicroAmount	Required
asset	“USDC” / “USDT”	Optional

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "kind",
    "address",
    "amount_micro"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "withdrawal",
        "payout"
      ]
    },
    "network": {
      "type": "string",
      "enum": [
        "base"
      ]
    },
    "address": {
      "$ref": "#/components/schemas/EvmAddress"
    },
    "amount_micro": {
      "$ref": "#/components/schemas/MicroAmount"
    },
    "asset": {
      "type": "string",
      "enum": [
        "USDC",
        "USDT"
      ]
    }
  }
}

Responses

202

Code sent.

application/json

Field	Type	Presence	Description
sent	schema	Required
expires_at	Rfc3339Utc	Required

{
  "type": "object",
  "additionalProperties": false,
  "required": [
    "sent",
    "expires_at"
  ],
  "properties": {
    "sent": {
      "const": true
    },
    "expires_at": {
      "$ref": "#/components/schemas/Rfc3339Utc"
    }
  }
}

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

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/withdrawals/code' \
  --header "Authorization: Bearer $AMPLERUN_API_KEY"

Schema definitions · Download OpenAPI · Authentication · Errors and recovery