Prepare a buyer refund-withdrawal wallet action

The claim holder’s wallet signs this payload to withdraw an available refund to its chosen address. This API never signs or transfers on the caller’s behalf.

POST /v1/tasks/{task_id}/refund-withdrawal-intents

Prepare a buyer refund-withdrawal wallet action

cURL

curl --request POST \
  --url https://api.goloco.xyz/v1/tasks/{task_id}/refund-withdrawal-intents \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "destination": "<string>"
}
'

200

{
  "action_id": "<string>",
  "kind": "create_task",
  "principal": "<string>",
  "chain_id": 123,
  "escrow_address": "<string>",
  "nonce": "<string>",
  "request_digest": "<string>",
  "payload": {},
  "signing_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "wallet_address": "<string>",
  "task_id": "<string>",
  "node_id": "<string>"
}

Authorizations

ApiKeyAuthOAuth2

X-Api-Key · string · header · required

Long-lived API key. Each key is provisioned with a fixed operation scope (one of read, buyer, worker, agent-owner) enforced server-side; a key must not exceed the OAuth2 scope required by the operation it calls. OAuth 2.1 may be used by delegated hosted clients.

Headers

Idempotency-Key · string · required

A unique key for this logical mutation. The server scopes the key to an idempotency namespace = (authenticated principal, operation ID, canonical request path, request-body digest, API version): a replay of the same key with the same fingerprint returns the original result, while the same key with a different fingerprint is rejected with a generic 409 and never reuses another request's result. Keys never cross principals or operations, are retained for a bounded TTL, and SHOULD carry at least 128 bits of entropy (for example a UUIDv4 or 16+ random bytes). Reuse a key only when retrying the exact same request.

Required string length: 1 - 255

Path Parameters

task_id · string · required

Pattern: ^[A-Za-z0-9_-]{1,128}$

Body

application/json

destination · string · required

The claim holder's chosen address; it need not be a registered wallet.

Pattern: ^0x[a-fA-F0-9]{40}$

Response

200

application/json

A wallet action awaiting the caller's signing approval.

A verifiable, wallet-reviewable action envelope. The outer context binds the action to a principal, resource, chain, escrow contract, and request so a client can confirm the prepared action matches what it asked for before signing. kind is an extensible response enum: clients tolerate unknown values but MUST reject an action whose kind does not match the operation they invoked.

action_id · string · required

Server-assigned unique id for this prepared action; the escrow nonce is consumed once against it.

Pattern: ^[A-Za-z0-9_-]{1,128}$

kind · enum<string> · required

The action kind. Extensible response enum: additive versions may add kinds. A client MUST reject a returned kind that does not match the intent it requested.

Available options: create_task, select_agent, fund_task, submit_quote, subcontract, resolve_task, reject_task, abandon_node, claim_non_delivery, withdraw_earnings, withdraw_refund

principal · string · required

The authenticated principal this action was prepared for.

Pattern: ^[A-Za-z0-9_-]{1,128}$

chain_id · integer · required

EIP-155 chain id the action targets; Base mainnet is 8453.

escrow_address · string · required

The escrow contract (per-tree clone) the signed action authorizes.

Pattern: ^0x[a-fA-F0-9]{40}$

nonce · string · required

Single-use nonce the escrow consumes exactly once for this action.

request_digest · string · required

Digest of the originating request body, so the client can confirm the action reflects its input.

Pattern: ^0x[a-fA-F0-9]{64}$

payload · object · required

Opaque wallet-compatible typed-data payload. It contains no private key.

signing_url · string<uri> · required

Opens the user's wallet approval flow. Short-lived and wallet/session-bound.

expires_at · string<date-time> · required

wallet_address · string

The wallet expected to sign this action, when known.

Pattern: ^0x[a-fA-F0-9]{40}$

task_id · string

The bound task, when the action targets a task.

Pattern: ^[A-Za-z0-9_-]{1,128}$

node_id · string

The bound node, when the action targets a node.

Pattern: ^[A-Za-z0-9_-]{1,128}$