List financial operations
Lists actual financial requests owned by the caller, including direct withdrawals and requests from agent runs or automation occurrences. Each resource includes immutable requested terms, exact approval and grant links, current lifecycle, safe frozen plan terms and all persisted leg receipts. Pagination does not truncate a resource or depend on journal replay.
Authentication
Both headers are required.
- Header:
X-Api-Key: YOUR_API_KEY - Header:
Authorization: Bearer YOUR_USER_TOKEN
Path parameters
userIdstring · uuidrequiredThe user in the path; must equal the token's own account.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Query parameters
cursorstringoptionalWhere the previous page ended; omit for the first page
Validation rules
- Maximum length
256
limitintegeroptionalHow many rows to answer, at most 100
Validation rules
- Default
50- Minimum
1- Maximum
100
runIdstring · uuidoptionalInclude only operations proposed by this stable agent run.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
conversationIdstring · uuidoptionalInclude only operations linked to this conversation; direct operations have no conversation.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
originstringoptionalInclude direct user requests or agent tool calls; omit to include both.
Validation rules
- Allowed values
["direct","agent"]
Request example
Illustrative request. Replace the host, credentials and resource IDs with your own. If a request file is shown, create it from the schema above. Review the requested action before sending it.
curl --request GET 'https://api.example.test/v1/users/YOUR_USER_ID/financial-operations' \
--header 'X-Api-Key: YOUR_API_KEY' \
--header 'Authorization: Bearer YOUR_USER_TOKEN'
Responses
200 A page of complete financial operations.
A page of complete financial operations.
application/json · object
dataarrayrequiredThis page's rows.
Show attributes
This page's rows.
Array items · object
A user-owned financial request with its exact consent, frozen plan, execution claims and public settlement evidence.
idstring · uuidrequiredThe durable financial operation's id, independent of any conversation or run.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
kindstringrequiredThe requested capability: a direct withdrawal to the owner or an agent's exact intents request.
Validation rules
- Allowed values
["withdraw_to_owner","intents_execute"]
originstringrequiredWhether the request came directly from the user or from a recorded agent tool call.
Validation rules
- Allowed values
["direct","agent"]
conversationIdanyOfrequiredThe proposing agent's conversation; null for a direct request.
Show attributes
The proposing agent's conversation; null for a direct request.
anyOf · 2 variants
Variant 1 · string · uuid
The conversation's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Variant 2 · null
runIdanyOfrequiredThe stable agent run that proposed the request; null for a direct request.
Show attributes
The stable agent run that proposed the request; null for a direct request.
anyOf · 2 variants
Variant 1 · string · uuid
The stable public agent run id, retained across approval continuations.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Variant 2 · null
callIdstring or nullrequiredThe actual recorded model tool call that proposed the request; null for a direct request.
automationOccurrenceIdanyOfrequiredThe actual automation occurrence linked to the proposing run; null when none exists. An occurrence itself grants no financial consent.
Show attributes
The actual automation occurrence linked to the proposing run; null when none exists. An occurrence itself grants no financial consent.
anyOf · 2 variants
Variant 1 · string · uuid
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Variant 2 · null
requestanyOfrequiredThe original exact actions and bounds; null only for older records that did not retain the request.
Show attributes
The original exact actions and bounds; null only for older records that did not retain the request.
anyOf · 2 variants
Variant 1 · object
actionsarrayrequiredThe complete ordered financial actions proposed for this execution, with concrete assets and exact quantity rules.
Show attributes
The complete ordered financial actions proposed for this execution, with concrete assets and exact quantity rules.
Validation rules
- Minimum items
1- Maximum items
16
Array items · oneOf
oneOf · 2 variants
Variant 1 · kind: swap
kindstringrequiredExchange one asset for another; custody never leaves the agent wallet.
Validation rules
- Exact value
"swap"
inputobjectrequiredThe concrete asset this request spends; it must match the approved action at this position.
Show attributes
The concrete asset this request spends; it must match the approved action at this position.
pinnedobjectrequiredThe exact input asset's token id and decimals.
Show attributes
The exact input asset's token id and decimals.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 5 variants
Variant 1 · kind: exact_input_tokens
Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
outputobjectrequiredThe concrete asset this request produces; it must match the approved action at this position.
Show attributes
The concrete asset this request produces; it must match the approved action at this position.
pinnedobjectrequiredThe exact output asset's token id and decimals.
Show attributes
The exact output asset's token id and decimals.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · kind: withdraw_to_owner
kindstringrequiredReturn an asset to the account that owns the agent wallet.
Validation rules
- Exact value
"withdraw_to_owner"
inputobjectrequiredThe concrete asset this request spends; it must match the approved action at this position.
Show attributes
The concrete asset this request spends; it must match the approved action at this position.
pinnedobjectrequiredThe exact input asset's token id and decimals.
Show attributes
The exact input asset's token id and decimals.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 5 variants
Variant 1 · kind: exact_input_tokens
Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
outputobjectrequiredThe concrete asset this request produces; it must match the approved action at this position.
Show attributes
The concrete asset this request produces; it must match the approved action at this position.
pinnedobjectrequiredThe exact output asset's token id and decimals.
Show attributes
The exact output asset's token id and decimals.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
boundsobjectrequiredThe explicit loss and signature-lifetime limits; these must exactly match the approved grant.
Show attributes
The explicit loss and signature-lifetime limits; these must exactly match the approved grant.
maxValueLossBpsstringrequiredThe most value an execution may give up to price movement and fees together, in basis points.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
maxSignatureLifetimeSecondsintegerrequiredExplicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity.
Validation rules
- Minimum
1- Maximum
259500
Variant 2 · null
requestApprovalIdanyOfrequiredThe approval of this exact request, if one was required; null when a standing grant supplies consent.
Show attributes
The approval of this exact request, if one was required; null when a standing grant supplies consent.
anyOf · 2 variants
Variant 1 · string · uuid
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Variant 2 · null
requestApprovalanyOfrequiredThe exact request's review terms and decision, readable without replaying a conversation; null when no request approval exists.
Show attributes
The exact request's review terms and decision, readable without replaying a conversation; null when no request approval exists.
anyOf · 2 variants
Variant 1 · object
approvalIdstring · uuidrequiredThe exact request approval's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
statusstringrequiredThe decision state; an undecided approval past its deadline is presented as expired.
Validation rules
- Allowed values
["pending","approved","denied","expired"]
expiresAtstring · date-timerequiredThe latest time this approval may authorize execution, even if already approved.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
contractoneOfoptionalThe exact financial terms retained for this approval, when available.
Show attributes
The exact financial terms retained for this approval, when available.
oneOf · 1 variants
Variant 1 · type: near_intents_transfer
typestringrequiredWhich contract template this is.
Validation rules
- Exact value
"near_intents_transfer"
actionsarrayrequiredThe actions this contract authorizes, executed in order.
Show attributes
The actions this contract authorizes, executed in order.
Validation rules
- Minimum items
1- Maximum items
16
Array items · oneOf
oneOf · 3 variants
Variant 1 · kind: swap
kindstringrequiredExchange one asset for another; custody never leaves the agent wallet.
Validation rules
- Exact value
"swap"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 5 variants
Variant 1 · kind: exact_input_tokens
Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
Variant 2 · kind: withdraw_to_owner
kindstringrequiredReturn an asset to the account that owns the agent wallet.
Validation rules
- Exact value
"withdraw_to_owner"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 5 variants
Variant 1 · kind: exact_input_tokens
Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
Variant 3 · kind: send
kindstringrequiredPay a pinned destination outside the agent wallet.
Validation rules
- Exact value
"send"
inputanyOfrequiredThe asset this action spends: pinned to one token, or any token the agent wallet holds.
Show attributes
The asset this action spends: pinned to one token, or any token the agent wallet holds.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
quantityoneOfrequiredHow much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
Show attributes
How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it.
oneOf · 5 variants
Variant 1 · kind: exact_input_tokens
Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw "5000000". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash.
kindstringrequiredSpend an exact amount of the input token.
Validation rules
- Exact value
"exact_input_tokens"
amountRawstringrequiredThe exact input amount, in the input token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_input_value_usd
Spend a USD-denominated value of the input token: "$5 worth of USDC" means value "5". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity.
kindstringrequiredSpend a USD-denominated value of the input token.
Validation rules
- Exact value
"exact_input_value_usd"
valuestringrequiredThe USD value to spend, as a decimal string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$"
Variant 3 · kind: exact_output_tokens
Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash.
kindstringrequiredReceive an exact amount of the output token.
Validation rules
- Exact value
"exact_output_tokens"
amountRawstringrequiredThe exact output amount, in the output token's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 4 · kind: all_of_input
kindstringrequiredSpend everything the agent wallet holds of the input asset.
Validation rules
- Exact value
"all_of_input"
Variant 5 · kind: fraction_of_input
kindstringrequiredSpend a fraction of the input asset.
Validation rules
- Exact value
"fraction_of_input"
bpsstringrequiredThe fraction to spend, in basis points of the input asset.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
outputanyOfrequiredThe asset this action produces: pinned to one token, or left open.
Show attributes
The asset this action produces: pinned to one token, or left open.
anyOf · 2 variants
Variant 1 · object
pinnedobjectrequiredThe exact token this asset is pinned to.
Show attributes
The exact token this asset is pinned to.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
Variant 2 · object
anybooleanrequiredAny token the agent wallet holds; the executor picks one at execution.
Validation rules
- Exact value
true
recipientobjectrequiredThe pinned destination this action pays.
Show attributes
The pinned destination this action pays.
chainstringrequiredWhich chain the destination address is on.
Validation rules
- Minimum length
1- Maximum length
32
addressstringrequiredThe destination address on that chain.
Validation rules
- Pattern
"^[\\x21-\\x7e]{1,128}$"
validUntilstring · date-timerequiredWhen this contract's authority expires.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
maxExecutionsintegerrequiredHow many times this contract may be executed before it is exhausted.
Validation rules
- Minimum
1- Maximum
10000
boundsobjectrequiredThe value-loss and signature-lifetime limits every execution must respect.
Show attributes
The value-loss and signature-lifetime limits every execution must respect.
maxValueLossBpsstringrequiredThe most value an execution may give up to price movement and fees together, in basis points.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,4})$"
maxSignatureLifetimeSecondsintegerrequiredExplicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity.
Validation rules
- Minimum
1- Maximum
259500
executionRestrictionstringoptionalPresent when the reviewed action was restricted to a mode that cannot sign or move funds.
Validation rules
- Exact value
"signing_disabled"
Variant 2 · null
grantApprovalIdanyOfrequiredThe approval that created the immutable authorization grant used for execution; null before a grant is bound.
Show attributes
The approval that created the immutable authorization grant used for execution; null before a grant is bound.
anyOf · 2 variants
Variant 1 · string · uuid
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
Variant 2 · null
statestringrequiredThe command lifecycle. Prepared awaits consent, denied or expired cannot start, executing has claimed authority, reported has returned an executor outcome, and uncertain records an inconclusive command ending. Later receipts may resolve settlement independently; inspect result and terminal.
Validation rules
- Allowed values
["prepared","denied","expired","executing","reported","uncertain"]
resultanyOfrequiredThe latest safe executor or receipt-derived outcome; null before an outcome is known, including denied or expired preparations.
Show attributes
The latest safe executor or receipt-derived outcome; null before an outcome is known, including denied or expired preparations.
anyOf · 2 variants
Variant 1 · anyOf
anyOf · 3 variants
Variant 1 · status: no_trade
statusstringrequiredThe request resolved without attempting a financial action.
Validation rules
- Exact value
"no_trade"
Variant 2 · status: refused
statusstringrequiredThe financial command refused execution under its authority or safety checks.
Validation rules
- Exact value
"refused"
scopestringrequiredThe bounded category of the refusal; no provider text, account details or amounts are exposed here.
Validation rules
- Allowed values
["authority","request","transient","insufficient_funds","request_frozen","verification","stale_evidence","account_busy","conflict","paused","held","withdrawn"]
Variant 3 · object
statusstringrequiredThe financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. Partial may still await receipts; the operation's terminal field states whether reconciliation remains.
Validation rules
- Allowed values
["settled","pending","partial","refunded","not_executed"]
reasonstringoptionalPresent when execution was restricted to a mode that cannot sign or move funds.
Validation rules
- Exact value
"signing_disabled"
legsarrayrequiredThe actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Show attributes
The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt.
Validation rules
- Maximum items
16
Array items · object
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
statestringrequiredThe recorded execution or settlement state of this actual leg.
Validation rules
- Allowed values
["claimed","signed","uncertain","settled","refunded","not_executed"]
Variant 2 · null
terminalbooleanrequiredWhether the request is finished: consent was denied or expired before execution, or execution is conclusively resolved with no actual leg awaiting a receipt. True does not mean funds settled; inspect result and receipts.
createdAtstring · date-timerequiredWhen the financial request was durably recorded.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
startedAtanyOfrequiredWhen execution authority was claimed; null before that claim, and never proof of provider dispatch.
Show attributes
When execution authority was claimed; null before that claim, and never proof of provider dispatch.
anyOf · 2 variants
Variant 1 · string · date-time
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
Variant 2 · null
reportedAtanyOfrequiredWhen the executor durably reported its outcome; null before reporting. Settlement may resolve later.
Show attributes
When the executor durably reported its outcome; null before reporting. Settlement may resolve later.
anyOf · 2 variants
Variant 1 · string · date-time
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
Variant 2 · null
plananyOfrequiredThe complete frozen plan, or null before planning. Planned legs are not evidence that an action was attempted.
Show attributes
The complete frozen plan, or null before planning. Planned legs are not evidence that an action was attempted.
anyOf · 2 variants
Variant 1 · object
idstring · uuidrequiredThe frozen execution plan's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
createdAtstring · date-timerequiredWhen these execution terms were frozen.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
expiresAtstring · date-timerequiredThe deadline after which this plan cannot authorize new signing.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
legsarrayrequiredEvery ordered planned action and its frozen amounts and limits, including actions that were never attempted.
Show attributes
Every ordered planned action and its frozen amounts and limits, including actions that were never attempted.
Array items · oneOf
oneOf · 2 variants
Variant 1 · kind: exact_input
kindstringrequiredSpends the fixed input amount and requires at least minimumOutputRaw in return.
Validation rules
- Exact value
"exact_input"
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
actionIndexintegerrequiredThe zero-based index of the original requested action this leg implements.
Validation rules
- Minimum
0- Maximum
15
inputobjectrequiredThe pinned input asset and exact amount this leg may spend.
Show attributes
The pinned input asset and exact amount this leg may spend.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringrequiredThe exact input amount, in the asset's smallest unit as an integer string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
outputobjectrequiredThe pinned asset this leg must receive.
Show attributes
The pinned asset this leg must receive.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
minimumOutputRawstringrequiredThe minimum acceptable output amount, in the output asset's smallest unit as an integer string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
referenceOutputRawstringrequiredThe reference output amount from trusted price evidence before applying the approved loss bound, in the output asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · kind: exact_output
kindstringrequiredReceives the fixed output amount and spends no more than maximumInputRaw.
Validation rules
- Exact value
"exact_output"
indexintegerrequiredThe leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
15
actionIndexintegerrequiredThe zero-based index of the original requested action this leg implements.
Validation rules
- Minimum
0- Maximum
15
inputobjectrequiredThe pinned asset this leg may spend.
Show attributes
The pinned asset this leg may spend.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
outputobjectrequiredThe pinned output asset and exact amount this leg must receive.
Show attributes
The pinned output asset and exact amount this leg must receive.
tokenIdstringrequiredThe token's NEP-141 identifier.
Validation rules
- Pattern
"^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$"
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringrequiredThe exact output amount, in the asset's smallest unit as an integer string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
maximumInputRawstringrequiredThe maximum permitted input amount, in the input asset's smallest unit as an integer string.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
referenceInputRawstringrequiredThe reference input amount from trusted price evidence before applying the approved loss bound, in the input asset's smallest unit.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · null
legsarrayrequiredAll actual execution legs and their receipts, in plan order. Unattempted planned legs have no invented claim or receipt.
Show attributes
All actual execution legs and their receipts, in plan order. Unattempted planned legs have no invented claim or receipt.
Array items · object
idstring · uuidrequiredThe durable claim's id for this actual execution leg.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
indexintegerrequiredThis leg's zero-based position in the frozen plan.
Validation rules
- Minimum
0- Maximum
9007199254740991
statestringrequiredThe leg's current execution or settlement state; unresolved states require reconciliation, not a second execution.
Validation rules
- Allowed values
["claimed","signed","uncertain","settled","refunded","not_executed"]
createdAtstring · date-timerequiredWhen this execution leg was claimed.
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
signedAtanyOfrequiredWhen the leg's signature was durably recorded; null before signing.
Show attributes
When the leg's signature was durably recorded; null before signing.
anyOf · 2 variants
Variant 1 · string · date-time
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
Variant 2 · null
settledAtanyOfrequiredWhen the leg's terminal resolution was recorded; null while unresolved. Consult the receipt to distinguish settlement, refund and non-execution.
Show attributes
When the leg's terminal resolution was recorded; null while unresolved. Consult the receipt to distinguish settlement, refund and non-execution.
anyOf · 2 variants
Variant 1 · string · date-time
Validation rules
- Format
"date-time"- Pattern
"^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
Variant 2 · null
receiptanyOfrequiredThe complete verified public resolution for this actual leg; null while unresolved. Never contains signatures or raw provider payloads.
Show attributes
The complete verified public resolution for this actual leg; null while unresolved. Never contains signatures or raw provider payloads.
anyOf · 2 variants
Variant 1 · oneOf
oneOf · 3 variants
Variant 1 · object
approvalIdstring · uuidrequiredThe approval's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg settled: its output asset moved as planned.
Validation rules
- Exact value
"settled"
outputobjectrequiredWhat the leg produced.
Show attributes
What the leg produced.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 2 · object
approvalIdstring · uuidrequiredThe approval's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg did not settle and its input asset was returned.
Validation rules
- Exact value
"refunded"
refundobjectrequiredWhat was returned.
Show attributes
What was returned.
tokenIdstringrequiredThe asset's NEP-141 token id.
Validation rules
- Minimum length
1- Maximum length
256
decimalsintegerrequiredHow many decimal places the token's smallest unit represents.
Validation rules
- Minimum
0- Maximum
38
amountRawstringoptionalThe amount, in the token's smallest unit, when it is known.
Validation rules
- Pattern
"^(0|[1-9]\\d{0,38})$"
Variant 3 · object
approvalIdstring · uuidrequiredThe approval's id.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
legIdstring · uuidrequiredWhich leg of the plan this receipt settles.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
indexintegerrequiredThis leg's position within the plan, counting from zero.
Validation rules
- Minimum
0- Maximum
15
operationIdstring · uuidoptionalThe durable financial request this evidence belongs to.
Validation rules
- Format
"uuid"- Pattern
"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
occurrenceIdstringoptionalThe archived event's original identity, retained verbatim; current receipts use operationId.
Validation rules
- Minimum length
1- Maximum length
160
statestringrequiredThe leg did not settle. Most reasons mean it never reached the provider; rejected means it did and was refused there — see reason.
Validation rules
- Exact value
"not_executed"
reasonstringoptionalWhy nothing executed: signing_disabled when automatic signing was off, signing_failed when signing itself failed, rejected when the provider refused the submission outright (it did reach the provider), expired when the leg's own signing/deposit window elapsed before a terminal fact arrived, or failed otherwise. Optional so receipts written before the reason was carried still parse.
Validation rules
- Allowed values
["signing_disabled","signing_failed","rejected","expired","failed"]
Variant 2 · null
nextCursorstring or nullrequiredThe cursor for the next page; null once there are no more rows.
totalintegeroptionalHow many rows the list holds in all, when it is known.
Validation rules
- Minimum
0- Maximum
9007199254740991
400 The request could not be read as this operation expects.
The request could not be read as this operation expects.
invalid_input— the body or query failed validation;issuesnames each fieldinvalid_cursor— thecursoris not one this list minted
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
401 A credential is missing, invalid or expired.
A credential is missing, invalid or expired.
partner_key_required— noX-Api-Keyheader was sentpartner_key_invalid— theX-Api-Keyis unknown or revokedcredential_expired— the user token has expired; obtain a fresh one
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
403 The credentials are valid but may not do this.
The credentials are valid but may not do this.
subject_mismatch— the{userId}in the path is not the token's useraccount_disabled— an operator disabled the accountorigin_rejected— a browserOriginother than the configured web origin
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
404 The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
412 The identity is verified but has no account yet.
The identity is verified but has no account yet.
account_not_provisioned— the identity is verified but has no account yet; callusers.ensurefirst
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
429 A limiter refused the request; honour `Retry-After`.
A limiter refused the request; honour Retry-After.
rate_limited— the per-key or per-user limit is spent; honourRetry-After
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
500 A fault on our side; quote `requestId` when reporting it.
A fault on our side; quote requestId when reporting it.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
503 The replica is draining or a dependency did not answer; `retryable` says whether to try again.
The replica is draining or a dependency did not answer; retryable says whether to try again.
internal— a fault on our side; quoterequestIdwhen reporting it
application/problem+json · object
RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack.
typestringrequiredThe kind of problem as a URN, urn:fin:error:<kind>; stable, compare against it
titlestringrequiredThe kind's human title, for logs; never parse it
statusintegerrequiredThe HTTP status, repeated in the body
Validation rules
- Minimum
400- Maximum
599
reasonstringoptionalThe machine-readable why. One of:
run_active(409) — a run already holds this conversationbudget_exhausted(409) — the user's spend headroom is gone, or an operator froze itapproval_not_pending(409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversationexecution_capacity(409) — no execution capacity is free right now;retryablesays whether to try againexecution_unavailable(409) — the execution engine could not take the workstop_pending(409) — a stop is already in progress and its cleanup is not yet confirmedautomation_changed(409) — therevisionsent is stale; reload the automationautomation_held(409) — an operator holds the automation; it fires again when releasedautomation_invalid(409) — the automation's definition cannot run as writtenautomation_completed(409) — the automation has finished for good and cannot fire againautomation_limit(409) — the user already has as many automations as the deployment allowsprofile_unknown_tool(409) — the run profile names a tool this deployment does not havedeployment_paused(409) — an operator paused a deployment control; nothing was admitted or firedrun_not_active(409) — the run named in the path is not the conversation's live runwithdrawal_changed(409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progresscredential_expired(401) — the user token has expired; obtain a fresh oneaccount_disabled(403) — an operator disabled the accountaccount_not_provisioned(412) — the identity is verified but has no account yet; callusers.ensurefirstprovider_unavailable(503) — an external provider the call depends on did not answerengine_unavailable(503) — the execution engine did not answerinvalid_input(400) — the body or query failed validation;issuesnames each fieldinternal(500) — a fault on our side; quoterequestIdwhen reporting itpartner_key_required(401) — noX-Api-Keyheader was sentpartner_key_invalid(401) — theX-Api-Keyis unknown or revokedsubject_mismatch(403) — the{userId}in the path is not the token's userorigin_rejected(403) — a browserOriginother than the configured web originpermission_required(403) — the operator credential lacks the scope this call needsrate_limited(429) — the per-key or per-user limit is spent; honourRetry-Afterstream_capacity(429) — no stream socket is free on this replica or for this user; honourRetry-Afterinvalid_cursor(400) — thecursoris not one this list minted
Validation rules
- Allowed values
["run_active","budget_exhausted","approval_not_pending","execution_capacity","execution_unavailable","stop_pending","automation_changed","automation_held","automation_invalid","automation_completed","automation_limit","profile_unknown_tool","deployment_paused","run_not_active","withdrawal_changed","credential_expired","account_disabled","account_not_provisioned","provider_unavailable","engine_unavailable","invalid_input","internal","partner_key_required","partner_key_invalid","subject_mismatch","origin_rejected","permission_required","rate_limited","stream_capacity","invalid_cursor"]
requestIdstringrequiredThe id Fin used for this request; quote it when reporting a problem
retryablebooleanrequiredWhether repeating the same request later can succeed without changing it
detailstringoptionalOnly on invalid_input: which part of the request failed validation
issuesarrayoptionalOnly on invalid_input: one entry per failing field
Show attributes
Only on invalid_input: one entry per failing field
Array items · object
pathstringrequiredThe JSON pointer of the failing field; empty for the root object
messagestringrequiredWhy the field failed
Complete OpenAPI definition
The exact operation and all referenced components, including recursive schemas.
{
"operation": {
"operationId": "financialOperations.list",
"summary": "List financial operations",
"tags": [
"financial-operations"
],
"description": "Lists actual financial requests owned by the caller, including direct withdrawals and requests from agent runs or automation occurrences. Each resource includes immutable requested terms, exact approval and grant links, current lifecycle, safe frozen plan terms and all persisted leg receipts. Pagination does not truncate a resource or depend on journal replay.",
"parameters": [
{
"schema": {
"type": "string",
"maxLength": 256
},
"in": "query",
"name": "cursor",
"required": false,
"description": "Where the previous page ended; omit for the first page"
},
{
"schema": {
"default": 50,
"type": "integer",
"minimum": 1,
"maximum": 100
},
"in": "query",
"name": "limit",
"required": false,
"description": "How many rows to answer, at most 100"
},
{
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"in": "query",
"name": "runId",
"required": false,
"description": "Include only operations proposed by this stable agent run."
},
{
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"in": "query",
"name": "conversationId",
"required": false,
"description": "Include only operations linked to this conversation; direct operations have no conversation."
},
{
"schema": {
"type": "string",
"enum": [
"direct",
"agent"
]
},
"in": "query",
"name": "origin",
"required": false,
"description": "Include direct user requests or agent tool calls; omit to include both."
},
{
"schema": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"in": "path",
"name": "userId",
"required": true,
"description": "The user in the path; must equal the token's own account."
}
],
"security": [
{
"apiKey": [],
"userToken": []
}
],
"responses": {
"200": {
"description": "A page of complete financial operations.",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FinancialOperation"
},
"description": "This page's rows."
},
"nextCursor": {
"description": "The cursor for the next page; null once there are no more rows.",
"type": [
"string",
"null"
]
},
"total": {
"description": "How many rows the list holds in all, when it is known.",
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
},
"required": [
"data",
"nextCursor"
]
}
}
}
},
"400": {
"$ref": "#/components/responses/InvalidInput"
},
"401": {
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
},
"404": {
"$ref": "#/components/responses/NotFound"
},
"412": {
"$ref": "#/components/responses/AccountNotProvisioned"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
},
"500": {
"$ref": "#/components/responses/Internal"
},
"503": {
"$ref": "#/components/responses/Unavailable"
}
}
},
"components": {
"schemas": {
"FinancialOperation": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The durable financial operation's id, independent of any conversation or run."
},
"kind": {
"type": "string",
"enum": [
"withdraw_to_owner",
"intents_execute"
],
"description": "The requested capability: a direct withdrawal to the owner or an agent's exact intents request."
},
"origin": {
"type": "string",
"enum": [
"direct",
"agent"
],
"description": "Whether the request came directly from the user or from a recorded agent tool call."
},
"conversationId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The conversation's id."
},
{
"type": "null"
}
],
"description": "The proposing agent's conversation; null for a direct request."
},
"runId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The stable public agent run id, retained across approval continuations."
},
{
"type": "null"
}
],
"description": "The stable agent run that proposed the request; null for a direct request."
},
"callId": {
"description": "The actual recorded model tool call that proposed the request; null for a direct request.",
"type": [
"string",
"null"
]
},
"automationOccurrenceId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "The actual automation occurrence linked to the proposing run; null when none exists. An occurrence itself grants no financial consent."
},
"request": {
"anyOf": [
{
"type": "object",
"properties": {
"actions": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "swap",
"description": "Exchange one asset for another; custody never leaves the agent wallet."
},
"input": {
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact input asset's token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The concrete asset this request spends; it must match the approved action at this position."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact output asset's token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The concrete asset this request produces; it must match the approved action at this position."
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "withdraw_to_owner",
"description": "Return an asset to the account that owns the agent wallet."
},
"input": {
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact input asset's token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The concrete asset this request spends; it must match the approved action at this position."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact output asset's token id and decimals."
}
},
"required": [
"pinned"
],
"description": "The concrete asset this request produces; it must match the approved action at this position."
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
}
]
},
"description": "The complete ordered financial actions proposed for this execution, with concrete assets and exact quantity rules."
},
"bounds": {
"type": "object",
"properties": {
"maxValueLossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The most value an execution may give up to price movement and fees together, in basis points."
},
"maxSignatureLifetimeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 259500,
"description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity."
}
},
"required": [
"maxValueLossBps",
"maxSignatureLifetimeSeconds"
],
"description": "The explicit loss and signature-lifetime limits; these must exactly match the approved grant."
}
},
"required": [
"actions",
"bounds"
]
},
{
"type": "null"
}
],
"description": "The original exact actions and bounds; null only for older records that did not retain the request."
},
"requestApprovalId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "The approval of this exact request, if one was required; null when a standing grant supplies consent."
},
"requestApproval": {
"anyOf": [
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The exact request approval's id."
},
"status": {
"type": "string",
"enum": [
"pending",
"approved",
"denied",
"expired"
],
"description": "The decision state; an undecided approval past its deadline is presented as expired."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "The latest time this approval may authorize execution, even if already approved."
},
"contract": {
"description": "The exact financial terms retained for this approval, when available.",
"oneOf": [
{
"type": "object",
"properties": {
"type": {
"type": "string",
"const": "near_intents_transfer",
"description": "Which contract template this is."
},
"actions": {
"minItems": 1,
"maxItems": 16,
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "swap",
"description": "Exchange one asset for another; custody never leaves the agent wallet."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "withdraw_to_owner",
"description": "Return an asset to the account that owns the agent wallet."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
}
},
"required": [
"kind",
"input",
"quantity",
"output"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "send",
"description": "Pay a pinned destination outside the agent wallet."
},
"input": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action spends: pinned to one token, or any token the agent wallet holds."
},
"quantity": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_tokens",
"description": "Spend an exact amount of the input token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the input token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Spend an exact quantity of the input token, not its USD value. Exactly 5 USDC with verified input decimals 6 means amountRaw \"5000000\". Scale the requested decimal digits using the verified input decimals; reject excess fractional digits. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input_value_usd",
"description": "Spend a USD-denominated value of the input token."
},
"value": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})(?:\\.\\d{1,18})?$",
"description": "The USD value to spend, as a decimal string."
}
},
"required": [
"kind",
"value"
],
"description": "Spend a USD-denominated value of the input token: \"$5 worth of USDC\" means value \"5\". The host calculates token units from live prices. This does not mean exactly 5 USDC; never substitute it for a token-denominated quantity."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output_tokens",
"description": "Receive an exact amount of the output token."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the output token's smallest unit."
}
},
"required": [
"kind",
"amountRaw"
],
"description": "Receive an exact quantity of the output token. Scale the requested decimal digits using the verified output decimals to obtain amountRaw; reject excess fractional digits. The host calculates the required input. No floating-point arithmetic or bash."
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "all_of_input",
"description": "Spend everything the agent wallet holds of the input asset."
}
},
"required": [
"kind"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "fraction_of_input",
"description": "Spend a fraction of the input asset."
},
"bps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The fraction to spend, in basis points of the input asset."
}
},
"required": [
"kind",
"bps"
]
}
],
"description": "How much moves: an exact token amount, an exact USD value, an exact output amount, all of the input, or a fraction of it."
},
"output": {
"anyOf": [
{
"type": "object",
"properties": {
"pinned": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The exact token this asset is pinned to."
}
},
"required": [
"pinned"
]
},
{
"type": "object",
"properties": {
"any": {
"type": "boolean",
"const": true,
"description": "Any token the agent wallet holds; the executor picks one at execution."
}
},
"required": [
"any"
]
}
],
"description": "The asset this action produces: pinned to one token, or left open."
},
"recipient": {
"type": "object",
"properties": {
"chain": {
"type": "string",
"minLength": 1,
"maxLength": 32,
"description": "Which chain the destination address is on."
},
"address": {
"type": "string",
"pattern": "^[\\x21-\\x7e]{1,128}$",
"description": "The destination address on that chain."
}
},
"required": [
"chain",
"address"
],
"description": "The pinned destination this action pays."
}
},
"required": [
"kind",
"input",
"quantity",
"output",
"recipient"
]
}
]
},
"description": "The actions this contract authorizes, executed in order."
},
"validUntil": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When this contract's authority expires."
},
"maxExecutions": {
"type": "integer",
"minimum": 1,
"maximum": 10000,
"description": "How many times this contract may be executed before it is exhausted."
},
"bounds": {
"type": "object",
"properties": {
"maxValueLossBps": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,4})$",
"description": "The most value an execution may give up to price movement and fees together, in basis points."
},
"maxSignatureLifetimeSeconds": {
"type": "integer",
"minimum": 1,
"maximum": 259500,
"description": "Explicit maximum lifetime of each released transfer signature, in seconds. 1Click confidential swaps require up to 259500 seconds (72 hours 5 minutes). This does not extend the short execution window or approval validity."
}
},
"required": [
"maxValueLossBps",
"maxSignatureLifetimeSeconds"
],
"description": "The value-loss and signature-lifetime limits every execution must respect."
}
},
"required": [
"type",
"actions",
"validUntil",
"maxExecutions",
"bounds"
]
}
]
},
"executionRestriction": {
"description": "Present when the reviewed action was restricted to a mode that cannot sign or move funds.",
"type": "string",
"const": "signing_disabled"
}
},
"required": [
"approvalId",
"status",
"expiresAt"
]
},
{
"type": "null"
}
],
"description": "The exact request's review terms and decision, readable without replaying a conversation; null when no request approval exists."
},
"grantApprovalId": {
"anyOf": [
{
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
{
"type": "null"
}
],
"description": "The approval that created the immutable authorization grant used for execution; null before a grant is bound."
},
"state": {
"type": "string",
"enum": [
"prepared",
"denied",
"expired",
"executing",
"reported",
"uncertain"
],
"description": "The command lifecycle. Prepared awaits consent, denied or expired cannot start, executing has claimed authority, reported has returned an executor outcome, and uncertain records an inconclusive command ending. Later receipts may resolve settlement independently; inspect result and terminal."
},
"result": {
"anyOf": [
{
"anyOf": [
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "no_trade",
"description": "The request resolved without attempting a financial action."
}
},
"required": [
"status"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "refused",
"description": "The financial command refused execution under its authority or safety checks."
},
"scope": {
"type": "string",
"enum": [
"authority",
"request",
"transient",
"insufficient_funds",
"request_frozen",
"verification",
"stale_evidence",
"account_busy",
"conflict",
"paused",
"held",
"withdrawn"
],
"description": "The bounded category of the refusal; no provider text, account details or amounts are exposed here."
}
},
"required": [
"status",
"scope"
]
},
{
"type": "object",
"properties": {
"status": {
"type": "string",
"enum": [
"settled",
"pending",
"partial",
"refunded",
"not_executed"
],
"description": "The financial outcome: settled, unresolved, mixed or incomplete, refunded, or conclusively not executed. Partial may still await receipts; the operation's terminal field states whether reconciliation remains."
},
"reason": {
"description": "Present when execution was restricted to a mode that cannot sign or move funds.",
"type": "string",
"const": "signing_disabled"
},
"legs": {
"maxItems": 16,
"type": "array",
"items": {
"type": "object",
"properties": {
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"state": {
"type": "string",
"enum": [
"claimed",
"signed",
"uncertain",
"settled",
"refunded",
"not_executed"
],
"description": "The recorded execution or settlement state of this actual leg."
}
},
"required": [
"index",
"state"
]
},
"description": "The actual execution legs represented by this outcome; unattempted planned legs have no invented receipt."
}
},
"required": [
"status",
"legs"
]
}
]
},
{
"type": "null"
}
],
"description": "The latest safe executor or receipt-derived outcome; null before an outcome is known, including denied or expired preparations."
},
"terminal": {
"type": "boolean",
"description": "Whether the request is finished: consent was denied or expired before execution, or execution is conclusively resolved with no actual leg awaiting a receipt. True does not mean funds settled; inspect result and receipts."
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When the financial request was durably recorded."
},
"startedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
],
"description": "When execution authority was claimed; null before that claim, and never proof of provider dispatch."
},
"reportedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
],
"description": "When the executor durably reported its outcome; null before reporting. Settlement may resolve later."
},
"plan": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The frozen execution plan's id."
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When these execution terms were frozen."
},
"expiresAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "The deadline after which this plan cannot authorize new signing."
},
"legs": {
"type": "array",
"items": {
"oneOf": [
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_input",
"description": "Spends the fixed input amount and requires at least minimumOutputRaw in return."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"actionIndex": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The zero-based index of the original requested action this leg implements."
},
"input": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact input amount, in the asset's smallest unit as an integer string."
}
},
"required": [
"tokenId",
"decimals",
"amountRaw"
],
"description": "The pinned input asset and exact amount this leg may spend."
},
"output": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The pinned asset this leg must receive."
},
"minimumOutputRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The minimum acceptable output amount, in the output asset's smallest unit as an integer string."
},
"referenceOutputRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The reference output amount from trusted price evidence before applying the approved loss bound, in the output asset's smallest unit."
}
},
"required": [
"kind",
"index",
"actionIndex",
"input",
"output",
"minimumOutputRaw",
"referenceOutputRaw"
]
},
{
"type": "object",
"properties": {
"kind": {
"type": "string",
"const": "exact_output",
"description": "Receives the fixed output amount and spends no more than maximumInputRaw."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The leg's zero-based position in the frozen plan."
},
"actionIndex": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "The zero-based index of the original requested action this leg implements."
},
"input": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
}
},
"required": [
"tokenId",
"decimals"
],
"description": "The pinned asset this leg may spend."
},
"output": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"pattern": "^nep141:[a-z0-9]+(?:[._-][a-z0-9]+)*$",
"description": "The token's NEP-141 identifier."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The exact output amount, in the asset's smallest unit as an integer string."
}
},
"required": [
"tokenId",
"decimals",
"amountRaw"
],
"description": "The pinned output asset and exact amount this leg must receive."
},
"maximumInputRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The maximum permitted input amount, in the input asset's smallest unit as an integer string."
},
"referenceInputRaw": {
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$",
"description": "The reference input amount from trusted price evidence before applying the approved loss bound, in the input asset's smallest unit."
}
},
"required": [
"kind",
"index",
"actionIndex",
"input",
"output",
"maximumInputRaw",
"referenceInputRaw"
]
}
]
},
"description": "Every ordered planned action and its frozen amounts and limits, including actions that were never attempted."
}
},
"required": [
"id",
"createdAt",
"expiresAt",
"legs"
]
},
{
"type": "null"
}
],
"description": "The complete frozen plan, or null before planning. Planned legs are not evidence that an action was attempted."
},
"legs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The durable claim's id for this actual execution leg."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "This leg's zero-based position in the frozen plan."
},
"state": {
"type": "string",
"enum": [
"claimed",
"signed",
"uncertain",
"settled",
"refunded",
"not_executed"
],
"description": "The leg's current execution or settlement state; unresolved states require reconciliation, not a second execution."
},
"createdAt": {
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$",
"description": "When this execution leg was claimed."
},
"signedAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
],
"description": "When the leg's signature was durably recorded; null before signing."
},
"settledAt": {
"anyOf": [
{
"type": "string",
"format": "date-time",
"pattern": "^(?:(?:\\d\\d[2468][048]|\\d\\d[13579][26]|\\d\\d0[48]|[02468][048]00|[13579][26]00)-02-29|\\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\\d|30)|(?:02)-(?:0[1-9]|1\\d|2[0-8])))T(?:(?:[01]\\d|2[0-3]):[0-5]\\d:[0-5]\\d(?:\\.\\d+)?(?:Z))$"
},
{
"type": "null"
}
],
"description": "When the leg's terminal resolution was recorded; null while unresolved. Consult the receipt to distinguish settlement, refund and non-execution."
},
"receipt": {
"anyOf": [
{
"oneOf": [
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "settled",
"description": "The leg settled: its output asset moved as planned."
},
"output": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "What the leg produced."
}
},
"required": [
"approvalId",
"legId",
"index",
"state",
"output"
]
},
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "refunded",
"description": "The leg did not settle and its input asset was returned."
},
"refund": {
"type": "object",
"properties": {
"tokenId": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"description": "The asset's NEP-141 token id."
},
"decimals": {
"type": "integer",
"minimum": 0,
"maximum": 38,
"description": "How many decimal places the token's smallest unit represents."
},
"amountRaw": {
"description": "The amount, in the token's smallest unit, when it is known.",
"type": "string",
"pattern": "^(0|[1-9]\\d{0,38})$"
}
},
"required": [
"tokenId",
"decimals"
],
"description": "What was returned."
}
},
"required": [
"approvalId",
"legId",
"index",
"state",
"refund"
]
},
{
"type": "object",
"properties": {
"approvalId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "The approval's id."
},
"legId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
"description": "Which leg of the plan this receipt settles."
},
"index": {
"type": "integer",
"minimum": 0,
"maximum": 15,
"description": "This leg's position within the plan, counting from zero."
},
"operationId": {
"description": "The durable financial request this evidence belongs to.",
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"occurrenceId": {
"description": "The archived event's original identity, retained verbatim; current receipts use `operationId`.",
"type": "string",
"minLength": 1,
"maxLength": 160
},
"state": {
"type": "string",
"const": "not_executed",
"description": "The leg did not settle. Most reasons mean it never reached the provider; `rejected` means it did and was refused there — see `reason`."
},
"reason": {
"description": "Why nothing executed: `signing_disabled` when automatic signing was off, `signing_failed` when signing itself failed, `rejected` when the provider refused the submission outright (it did reach the provider), `expired` when the leg's own signing/deposit window elapsed before a terminal fact arrived, or `failed` otherwise. Optional so receipts written before the reason was carried still parse.",
"type": "string",
"enum": [
"signing_disabled",
"signing_failed",
"rejected",
"expired",
"failed"
]
}
},
"required": [
"approvalId",
"legId",
"index",
"state"
]
}
]
},
{
"type": "null"
}
],
"description": "The complete verified public resolution for this actual leg; null while unresolved. Never contains signatures or raw provider payloads."
}
},
"required": [
"id",
"index",
"state",
"createdAt",
"signedAt",
"settledAt",
"receipt"
]
},
"description": "All actual execution legs and their receipts, in plan order. Unattempted planned legs have no invented claim or receipt."
}
},
"required": [
"id",
"kind",
"origin",
"conversationId",
"runId",
"callId",
"automationOccurrenceId",
"request",
"requestApprovalId",
"requestApproval",
"grantApprovalId",
"state",
"result",
"terminal",
"createdAt",
"startedAt",
"reportedAt",
"plan",
"legs"
],
"description": "A user-owned financial request with its exact consent, frozen plan, execution claims and public settlement evidence."
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The kind of problem as a URN, `urn:fin:error:<kind>`; stable, compare against it"
},
"title": {
"type": "string",
"description": "The kind's human title, for logs; never parse it"
},
"status": {
"type": "integer",
"minimum": 400,
"maximum": 599,
"description": "The HTTP status, repeated in the body"
},
"reason": {
"description": "The machine-readable why. One of:\n\n- `run_active` (409) — a run already holds this conversation\n- `budget_exhausted` (409) — the user's spend headroom is gone, or an operator froze it\n- `approval_not_pending` (409) — the approval was already decided or has expired, or its id does not exist or belongs to a different conversation\n- `execution_capacity` (409) — no execution capacity is free right now; `retryable` says whether to try again\n- `execution_unavailable` (409) — the execution engine could not take the work\n- `stop_pending` (409) — a stop is already in progress and its cleanup is not yet confirmed\n- `automation_changed` (409) — the `revision` sent is stale; reload the automation\n- `automation_held` (409) — an operator holds the automation; it fires again when released\n- `automation_invalid` (409) — the automation's definition cannot run as written\n- `automation_completed` (409) — the automation has finished for good and cannot fire again\n- `automation_limit` (409) — the user already has as many automations as the deployment allows\n- `profile_unknown_tool` (409) — the run profile names a tool this deployment does not have\n- `deployment_paused` (409) — an operator paused a deployment control; nothing was admitted or fired\n- `run_not_active` (409) — the run named in the path is not the conversation's live run\n- `withdrawal_changed` (409) — the withdrawal cannot be prepared or confirmed as asked: the balance no longer covers it, its terms changed or expired, or it is already in progress\n- `credential_expired` (401) — the user token has expired; obtain a fresh one\n- `account_disabled` (403) — an operator disabled the account\n- `account_not_provisioned` (412) — the identity is verified but has no account yet; call `users.ensure` first\n- `provider_unavailable` (503) — an external provider the call depends on did not answer\n- `engine_unavailable` (503) — the execution engine did not answer\n- `invalid_input` (400) — the body or query failed validation; `issues` names each field\n- `internal` (500) — a fault on our side; quote `requestId` when reporting it\n- `partner_key_required` (401) — no `X-Api-Key` header was sent\n- `partner_key_invalid` (401) — the `X-Api-Key` is unknown or revoked\n- `subject_mismatch` (403) — the `{userId}` in the path is not the token's user\n- `origin_rejected` (403) — a browser `Origin` other than the configured web origin\n- `permission_required` (403) — the operator credential lacks the scope this call needs\n- `rate_limited` (429) — the per-key or per-user limit is spent; honour `Retry-After`\n- `stream_capacity` (429) — no stream socket is free on this replica or for this user; honour `Retry-After`\n- `invalid_cursor` (400) — the `cursor` is not one this list minted",
"type": "string",
"enum": [
"run_active",
"budget_exhausted",
"approval_not_pending",
"execution_capacity",
"execution_unavailable",
"stop_pending",
"automation_changed",
"automation_held",
"automation_invalid",
"automation_completed",
"automation_limit",
"profile_unknown_tool",
"deployment_paused",
"run_not_active",
"withdrawal_changed",
"credential_expired",
"account_disabled",
"account_not_provisioned",
"provider_unavailable",
"engine_unavailable",
"invalid_input",
"internal",
"partner_key_required",
"partner_key_invalid",
"subject_mismatch",
"origin_rejected",
"permission_required",
"rate_limited",
"stream_capacity",
"invalid_cursor"
]
},
"requestId": {
"type": "string",
"description": "The id Fin used for this request; quote it when reporting a problem"
},
"retryable": {
"type": "boolean",
"description": "Whether repeating the same request later can succeed without changing it"
},
"detail": {
"description": "Only on `invalid_input`: which part of the request failed validation",
"type": "string"
},
"issues": {
"description": "Only on `invalid_input`: one entry per failing field",
"type": "array",
"items": {
"type": "object",
"properties": {
"path": {
"type": "string",
"description": "The JSON pointer of the failing field; empty for the root object"
},
"message": {
"type": "string",
"description": "Why the field failed"
}
},
"required": [
"path",
"message"
]
}
}
},
"required": [
"type",
"title",
"status",
"requestId",
"retryable"
],
"description": "RFC 9457 problem details: what every error response carries. Never a provider's message, a query or a stack."
}
},
"responses": {
"InvalidInput": {
"description": "The request could not be read as this operation expects.\n\n- `invalid_input` — the body or query failed validation; `issues` names each field\n- `invalid_cursor` — the `cursor` is not one this list minted",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unauthorized": {
"description": "A credential is missing, invalid or expired.\n\n- `partner_key_required` — no `X-Api-Key` header was sent\n- `partner_key_invalid` — the `X-Api-Key` is unknown or revoked\n- `credential_expired` — the user token has expired; obtain a fresh one",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Forbidden": {
"description": "The credentials are valid but may not do this.\n\n- `subject_mismatch` — the `{userId}` in the path is not the token's user\n- `account_disabled` — an operator disabled the account\n- `origin_rejected` — a browser `Origin` other than the configured web origin",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"NotFound": {
"description": "The resource is missing, belongs to someone else, or its id is malformed: all three answer alike.",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"AccountNotProvisioned": {
"description": "The identity is verified but has no account yet.\n\n- `account_not_provisioned` — the identity is verified but has no account yet; call `users.ensure` first",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"TooManyRequests": {
"description": "A limiter refused the request; honour `Retry-After`.\n\n- `rate_limited` — the per-key or per-user limit is spent; honour `Retry-After`",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Internal": {
"description": "A fault on our side; quote `requestId` when reporting it.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"Unavailable": {
"description": "The replica is draining or a dependency did not answer; `retryable` says whether to try again.\n\n- `internal` — a fault on our side; quote `requestId` when reporting it",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"securitySchemes": {
"apiKey": {
"type": "apiKey",
"in": "header",
"name": "X-Api-Key"
},
"userToken": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}