Build unsigned `setAutoRenew`, `setPayg` or `releaseEscrow` calls for an existing account (relayed free within the flag-call limits).
POST/v1/flags/prepare
Flag calls are relayed free of charge, up to 10 per 24 h and 30 per 30 days per account.
setPayg is encoded with four arguments: enabled, budget, auto_topup, max_payg_price.
renew: true builds renew(address), the dashboard's "Renew now". It is free only when the argument
is the sender's own account, so address is both the sender and the argument.
When the free allowance is used up, the response carries free: false and ru, and the call is
billed as a normal relay. An address that cannot be billed gets 429 RATE_LIMITED with
details.scope = free_flow.
503 CONTRACT_PAUSED while the contract's global pause is set.
Request
Responses
- 200
- 400
- 402
- 422
- 429
- 503
One unsigned transaction per requested change, consecutive nonces, one assignment.
MALFORMED_REQUEST, VARIANTS_NOT_SUPPORTED, RELAYER_SIGNATURE_PRESENT, CHAIN_ID_MISMATCH, TX_VERSION_UNSUPPORTED, TX_OPTIONS_UNSUPPORTED, LEASE_MISSING, CURSOR_INVALID.
Response Headers
Request id, also the instance of a problem document and the log correlation id.
NO_ENTITLEMENT (details.reason NO_ACCOUNT) - flag calls are co-signed only for addresses that already have an on-chain account.
REPLACEMENT_UNDERPRICED, RELAYER_UNKNOWN, RELAYER_SHARD_MISMATCH, GAS_PRICE_OUT_OF_RANGE, GAS_LIMIT_TOO_LOW, GAS_LIMIT_TOO_HIGH, GAS_OVERPROVISIONED, DATA_TOO_LARGE, SENDER_SIGNATURE_INVALID, GUARDIAN_*, INSUFFICIENT_SENDER_BALANCE, SIMULATION_FAILED, UNSUPPORTED_TX_FIELD, TIER_NOT_PURCHASABLE, DEPOSIT_BELOW_MIN, DEPOSIT_ABOVE_MAX, WEBHOOK_URL_NOT_ALLOWED, IDEMPOTENCY_KEY_REUSED.
RATE_LIMITED, GAS_BUDGET_EXCEEDED, HOURLY_BURN_EXCEEDED, TOO_MANY_IN_FLIGHT, QUOTA_EXHAUSTED (the latter without Retry-After; details.reason = CAP_REACHED_PAYG_OFF | PAYG_ESCROW_EMPTY).
Response Headers
Seconds (HTTP standard). Millisecond precision is in details.retryAfterMs of the problem body.
Requests (or RU on the relay path) allowed in the current window.
Remaining units in the current window.
Seconds until the window resets (IETF RateLimit header fields).
SWAP_VENUE_PAUSED (the exchange venue is paused), CONTRACT_PAUSED (the CoRelayer contract is paused: paused or deposits_paused; it is never reported as SWAP_VENUE_PAUSED), SWAP_BUDGET_EXHAUSTED, FREE_FLOW_UNAVAILABLE, NO_RELAYER_AVAILABLE, UPSTREAM_UNAVAILABLE (the x402 routes also return it when they cannot read their payment records), SIGNER_UNAVAILABLE, SIGNER_FENCED, SIGNER_TIMEOUT. All are answered before the commit point.
Response Headers
Seconds (HTTP standard). Millisecond precision is in details.retryAfterMs of the problem body.