Skip to content

POST /api/v1/withdrawal-addresses/confirm

Operation: confirmWithdrawalAddress.

Open the emailed link (no sign-in; the token is the proof)

Confirms the address and queues the parked withdrawal or payout exactly as requested. Idempotent. Refused after 30 minutes or after a credential change.

POST https://amplerun-api.spiry.org/api/v1/withdrawal-addresses/confirm

No default Bearer requirement is declared for this operation. Read its description for wallet signatures, host enrollment or other specialized proofs.

Required body.

FieldTypePresenceDescription
tokenstringRequired
{
"type": "object",
"additionalProperties": false,
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"pattern": "^[A-Za-z0-9_-]{43}$"
}
}
}

Confirmed.

application/json

FieldTypePresenceDescription
confirmedschemaRequired
kind“withdrawal” / “payout” / “address”Required
address_idUUIDRequired
intent_idUUID or nullRequired
{
"type": "object",
"additionalProperties": false,
"required": [
"confirmed",
"kind",
"address_id",
"intent_id"
],
"properties": {
"confirmed": {
"const": true
},
"kind": {
"type": "string",
"enum": [
"withdrawal",
"payout",
"address"
]
},
"address_id": {
"$ref": "#/components/schemas/UUID"
},
"intent_id": {
"anyOf": [
{
"$ref": "#/components/schemas/UUID"
},
{
"type": "null"
}
]
}
}
}

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

FieldTypePresenceDescription
errorobjectRequired
{
"$ref": "#/components/schemas/ErrorEnvelope"
}

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.

Terminal window
curl --request POST 'https://amplerun-api.spiry.org/api/v1/withdrawal-addresses/confirm'

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