Skip to main content
POST
/
v1
/
credit
/
reclaim
curl --request POST \
  --url https://sequencer.example.com/v1/credit/reclaim \
  --header 'Content-Type: application/json' \
  --data '{
  "authId": "0x1122334455667788990011223344556677889900112233445566778899001122",
  "callerType": "agent",
  "requestedAt": "1735690000",
  "agentId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "agentSig": "0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba"
}'
{
  "ok": true,
  "authId": "0x1122334455667788990011223344556677889900112233445566778899001122"
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/nhestrompia/shielded-x402/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint allows agents or the sequencer to reclaim expired authorizations that were never executed. When reclaimed, the authorized amount is returned to the agent’s available balance.

Request body

authId
string
required
32-byte hex identifier of the authorization to reclaim.
callerType
string
required
Type of caller making the reclaim request. Either agent or sequencer.
requestedAt
string
required
Uint64 Unix timestamp (seconds) when the reclaim was requested. Cannot be more than 300 seconds in the future.
agentId
string
32-byte hex agent identifier. Required when callerType is agent.
agentSig
string
Hex-encoded signature of the reclaim request by the agent. Required when callerType is agent.

Headers

x-sequencer-admin-token
string
Admin token for sequencer-initiated reclaims. Required when callerType is sequencer.

Response

ok
boolean
required
Always true on success.
authId
string
required
32-byte hex identifier of the reclaimed authorization.

Error codes

CodeDescription
INVALID_REQUESTMalformed request payload or validation error
NOT_FOUNDAuthorization not found
authorization not foundAuthId doesn’t exist
unauthorized sequencer reclaim callerInvalid or missing admin token for sequencer reclaim
agentId and agentSig are required for agent reclaimMissing required fields for agent reclaim
agent reclaim caller mismatchAgentId doesn’t match the authorization’s agent
agent signing metadata missingAgent hasn’t made any authorizations yet (no signature metadata stored)
invalid agent reclaim signatureAgent signature verification failed
only ISSUED authorizations can be reclaimedAuthorization status is not ISSUED (may be EXECUTED or already RECLAIMED)
authorization not yet expiredCannot reclaim before the authorization’s expiresAt timestamp
authorization already reclaimedAuthorization was already reclaimed
INVARIANT_VIOLATION outstanding balance lower than reclaim amountInternal accounting error
curl --request POST \
  --url https://sequencer.example.com/v1/credit/reclaim \
  --header 'Content-Type: application/json' \
  --data '{
  "authId": "0x1122334455667788990011223344556677889900112233445566778899001122",
  "callerType": "agent",
  "requestedAt": "1735690000",
  "agentId": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef",
  "agentSig": "0x9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba9876543210fedcba"
}'
{
  "ok": true,
  "authId": "0x1122334455667788990011223344556677889900112233445566778899001122"
}

Build docs developers (and LLMs) love