GET /api/v1/funding-intents/{id}
Operation: getFundingIntent.
Funding intent state (intent owner)
Read-only; never claims or credits. While a recorded transfer awaits finality, finalized_block_number is the RPC’s finalized head (null when the RPC is unreachable). No time estimate is given.
Endpoint
Section titled “Endpoint”GET https://amplerun-api.spiry.org/api/v1/funding-intents/{id}
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 |
|---|---|---|---|---|
id | path | Required | UUID |
Responses
Section titled “Responses”Funding intent.
application/json
| Field | Type | Presence | Description |
|---|---|---|---|
intent_id | UUID | Required | |
state | “PENDING” / “PENDING_FINALITY” / “CONFIRMED” / “EXCEPTION” | Required | |
chain_id | schema | Required | |
token | EvmAddress | Required | |
treasury_address | EvmAddress | Required | |
amount_micro | MicroAmount | Required | |
tx_hash | string or null | Required | |
log_index | integer or null | Required | |
block_number | string or null | Required | |
finalized_block_number | string or null | Required | |
credited_micro | MicroAmount or null | Required | Set once the deposit is credited. With state PENDING_FINALITY it was credited before finality (spendable now, withdrawable once final). |
exception_reason | string or null | Required | |
expires_at | Rfc3339Utc | Required | |
created_at | Rfc3339Utc | Required |
{ "type": "object", "additionalProperties": false, "required": [ "intent_id", "state", "chain_id", "token", "treasury_address", "amount_micro", "tx_hash", "log_index", "block_number", "finalized_block_number", "credited_micro", "exception_reason", "expires_at", "created_at" ], "properties": { "intent_id": { "$ref": "#/components/schemas/UUID" }, "state": { "enum": [ "PENDING", "PENDING_FINALITY", "CONFIRMED", "EXCEPTION" ] }, "chain_id": { "const": 8453 }, "token": { "$ref": "#/components/schemas/EvmAddress" }, "treasury_address": { "$ref": "#/components/schemas/EvmAddress" }, "amount_micro": { "$ref": "#/components/schemas/MicroAmount" }, "tx_hash": { "anyOf": [ { "type": "string", "pattern": "^0x[0-9a-fA-F]{64}$" }, { "type": "null" } ] }, "log_index": { "anyOf": [ { "type": "integer", "minimum": 0 }, { "type": "null" } ] }, "block_number": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" }, { "type": "null" } ] }, "finalized_block_number": { "anyOf": [ { "type": "string", "pattern": "^(0|[1-9][0-9]*)$" }, { "type": "null" } ] }, "credited_micro": { "description": "Set once the deposit is credited. With state PENDING_FINALITY it was credited before finality (spendable now, withdrawable once final).", "anyOf": [ { "$ref": "#/components/schemas/MicroAmount" }, { "type": "null" } ] }, "exception_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "expires_at": { "$ref": "#/components/schemas/Rfc3339Utc" }, "created_at": { "$ref": "#/components/schemas/Rfc3339Utc" } }}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 GET 'https://amplerun-api.spiry.org/api/v1/funding-intents/{id}' \ --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