import { createBusinessTransaction, ParmanaClient } from "@parmana/sdk";
import { readFileSync } from "node:fs";
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_API_KEY!,
});
const inEffect = await client.policyInEffect("paytm:refund");
// The signed approval the approver sent, for this order and up to this amount.
const approval = JSON.parse(readFileSync("approval.json", "utf8"));
const transaction = createBusinessTransaction({
principalId: (await client.caller()).callerId,
purpose: "Refund order ORD-1042",
action: "paytm:refund",
target: "ORD-1042",
parameters: { orderId: "ORD-1042", transactionId: "TXN-9", amount: 750 },
policy: inEffect.policy,
signals: {
refundEligible: true,
fraudCheckPassed: true,
refundAmount: 750,
managerApproved: true,
approvalArtifact: approval,
},
});
// Declares only: the transaction is recorded as RECEIVED and nothing is released.
// Release it with executeTransaction(declared.businessTransactionId).
const declared = await client.declareTransaction(transaction);
console.log(declared.businessTransactionId, declared.status);
import json
import os
from pathlib import Path
from parmana import ParmanaClient, create_business_transaction
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_API_KEY"],
)
in_effect = client.policy_in_effect("erp:invoice-pay")
# The signed approval the approver sent, for this order and up to this amount.
approval = json.loads(Path("approval.json").read_text())
transaction = create_business_transaction(
principal_id=client.caller().caller_id,
purpose="Refund order ORD-1042",
action="erp:invoice-pay",
target="ORD-1042",
parameters={"orderId": "ORD-1042", "transactionId": "TXN-9", "amount": 750},
policy=in_effect.policy,
signals={
"refundEligible": True,
"fraudCheckPassed": True,
"refundAmount": 750,
"managerApproved": True,
"approvalArtifact": approval,
},
)
# Declares only: the transaction is recorded as RECEIVED and nothing is released.
# Release it with client.execute_transaction(declared.business_transaction_id).
declared = client.declare_transaction(transaction)
print(declared.business_transaction_id, declared.status)
Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer . Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.
Body
application/json
Request payload for POST /execute and POST /transactions. status and createdAt are assigned by Parmana and must not be supplied by the client. Validation performed identically by both endpoints (each has its own inline businessTransactionId UUID check, then shares BusinessTransactionMapper.fromRequest and BusinessTransactionValidator): metadata.businessTransactionId must equal businessTransactionId; authorization.authorityId must equal authority.authorityId; intent.authorizationId must equal authorization.authorizationId; policy.name, policy.version, and intent.action must each be non-empty. No other structural validation is performed: authority, authorization, intent, policy, and signals objects are otherwise passed through as supplied, including any additional properties.
businessTransactionId
string<uuid>
required
Unique Business Transaction identifier. Must be a valid UUID on both POST /execute and POST /transactions (rejected with 400 otherwise).
metadata
Metadata · object
required
Immutable Business Transaction metadata supplied by the calling application. Not evaluated by Policy. businessTransactionId is the only required field; it must match the top-level businessTransactionId. Parmana rejects a mismatch with a 400.
Exact Policy to evaluate. The client explicitly supplies name, version, and schemaVersion; Parmana does not automatically discover or select a policy. If no matching policy file exists at policies/{name}/{version}/policy.json, the request fails with a 404 (policyId/policyVersion on POST /policies/validate) or a RUNTIME_ERROR (name/version elsewhere, from PolicyNotFoundError not otherwise mapped by the shared error handler in every route, see the error envelope note).
Opaque runtime facts evaluated by the resolved Policy's rules. Parmana assigns no business meaning to these values and does not statically validate them beyond the Policy's own signalsSchema declaration (see policies/{name}/{version}/policy.json). Scaled integers, not floats, for numeric signals such as amounts (house convention across every reference policy).
import { createBusinessTransaction, ParmanaClient } from "@parmana/sdk";
import { readFileSync } from "node:fs";
const client = new ParmanaClient({
endpoint: "https://parmana-api-real.vercel.app",
apiKey: process.env.PARMANA_API_KEY!,
});
const inEffect = await client.policyInEffect("paytm:refund");
// The signed approval the approver sent, for this order and up to this amount.
const approval = JSON.parse(readFileSync("approval.json", "utf8"));
const transaction = createBusinessTransaction({
principalId: (await client.caller()).callerId,
purpose: "Refund order ORD-1042",
action: "paytm:refund",
target: "ORD-1042",
parameters: { orderId: "ORD-1042", transactionId: "TXN-9", amount: 750 },
policy: inEffect.policy,
signals: {
refundEligible: true,
fraudCheckPassed: true,
refundAmount: 750,
managerApproved: true,
approvalArtifact: approval,
},
});
// Declares only: the transaction is recorded as RECEIVED and nothing is released.
// Release it with executeTransaction(declared.businessTransactionId).
const declared = await client.declareTransaction(transaction);
console.log(declared.businessTransactionId, declared.status);
import json
import os
from pathlib import Path
from parmana import ParmanaClient, create_business_transaction
client = ParmanaClient(
endpoint="https://parmana-api-real.vercel.app",
api_key=os.environ["PARMANA_API_KEY"],
)
in_effect = client.policy_in_effect("erp:invoice-pay")
# The signed approval the approver sent, for this order and up to this amount.
approval = json.loads(Path("approval.json").read_text())
transaction = create_business_transaction(
principal_id=client.caller().caller_id,
purpose="Refund order ORD-1042",
action="erp:invoice-pay",
target="ORD-1042",
parameters={"orderId": "ORD-1042", "transactionId": "TXN-9", "amount": 750},
policy=in_effect.policy,
signals={
"refundEligible": True,
"fraudCheckPassed": True,
"refundAmount": 750,
"managerApproved": True,
"approvalArtifact": approval,
},
)
# Declares only: the transaction is recorded as RECEIVED and nothing is released.
# Release it with client.execute_transaction(declared.business_transaction_id).
declared = client.declare_transaction(transaction)
print(declared.business_transaction_id, declared.status)
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"Parmana","description":"Parmana lets businesses set clear limits on what AI can do, checks every action against those limits, and keeps a record of each decision.","colors":{"primary":"#6366F1","light":"#6366F1","dark":"#4338CA"},"logo":{"light":"https://mintcdn.com/parmanasystems/3fc1F82PB1uU1_pD/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=3fc1F82PB1uU1_pD\u0026q=85\u0026s=902f62a6181def8e3c6b5aa71a40d247","dark":"https://mintcdn.com/parmanasystems/3fc1F82PB1uU1_pD/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=3fc1F82PB1uU1_pD\u0026q=85\u0026s=dba61af5a5c9f7960dbd6051e4ec24fb"},"favicon":"https://mintcdn.com/parmanasystems/3fc1F82PB1uU1_pD/logo/seal.svg?fit=max\u0026auto=format\u0026n=3fc1F82PB1uU1_pD\u0026q=85\u0026s=9ede6c2634c534c1d4eadfd76a08d84b","api":{"examples":{"prefill":true}},"background":{"color":{"light":"#FFFFFF","dark":"#1A1A1A"}},"navbar":{"links":[{"href":"https://github.com/pavancharak/parmana-verifier","label":"GitHub"},{"href":"https://github.com/pavancharak/parmana-verifier/discussions","label":"Discussions"}]},"footer":{"socials":{"github":"https://github.com/pavancharak/parmana-verifier"},"links":[{"header":"Legal","items":[{"label":"License and evaluation","href":"/license"},{"label":"Security","href":"https://docs.parmanasystems.com/license"}]}]},"fonts":{"family":"Inter"},"banner":{"content":"The Parmana repository, including the server, the SDKs and the offline verifier, is licensed under the Apache License 2.0. [License](/license)","dismissible":false},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"parmanasystems","hasAudioNarration":false,"actualSubdomain":"parmanasystems","customDomains":["docs.parmanasystems.com"],"gitSource":{"type":"github","owner":"pavancharak","repo":"parmana-core","deployBranch":"main","contentDirectory":"docs/site","isPrivate":false,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6b0193721c93281422a0802b","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":197},{"language":"default","tag":"TypeScript SDK","count":157},{"language":"default","tag":"REST API","count":100},{"language":"default","tag":"Interfaces","count":76},{"language":"default","tag":"Python SDK","count":52},{"language":"default","tag":"Classes","count":34},{"language":"default","tag":"Policy v2 (experimental)","count":28},{"language":"default","tag":"Guides","count":28},{"language":"default","tag":"Type Aliases","count":28},{"language":"default","tag":"Handbook","count":27}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[]}
{"page":{"pagePath":"api-reference/endpoints/create-transaction","slug":"/api-reference/endpoints/create-transaction","pageMetadata":{"title":"Declare a Business Transaction","description":"Declares a Business Transaction: it is checked, accepted and recorded with the status `RECEIVED`.","openapi":"openapi.bundled.yaml POST /transactions","href":"/api-reference/endpoints/create-transaction"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Declares a Business Transaction: it is checked, accepted and recorded with the status \", _jsx(_components.code, {\n children: \"RECEIVED\"\n }), \".\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Declare a Business Transaction","description":"Declares a Business Transaction: it is checked, accepted and recorded with the status `RECEIVED`.","openapi":"openapi.bundled.yaml POST /transactions","href":"/api-reference/endpoints/create-transaction"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Transactions"],"summary":"Declare a Business Transaction","operationId":"createTransaction","description":"Declares a Business Transaction: it is checked, accepted and recorded with the status `RECEIVED`.","requestBody":"bc12780b-a7c5-4a75-9f0b-4cd2decdda94","responses":{"201":"95c4acbc-b1dd-4cab-960b-f145c11276e7","400":"53eced25-9a82-4b6b-8f5a-6b227b7c152b","401":"e102ef17-7aa0-4988-bed5-70b4a4c1a71c","403":"52adeec1-a630-4601-8350-3a714bd49521","409":"ef8704fb-7eea-424f-9c94-bed81e79be83","429":"1bf155e4-7407-492c-a083-a1833075a9d2","500":"8e43145b-4dd1-4f50-9523-de9697bab2b2"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST https://parmana-api-real.vercel.app/transactions \\\n -H \"Authorization: Bearer $PARMANA_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"businessTransactionId\": \"4cfe5661-42a6-4db0-8372-2d24dca235f2\",\n \"metadata\": {\n \"businessTransactionId\": \"4cfe5661-42a6-4db0-8372-2d24dca235f2\",\n \"sourceSystem\": \"docs-api-reference\",\n \"submittedBy\": \"docs-example\"\n },\n \"authority\": {\n \"authorityId\": \"be8afa44-ee3c-44c2-a4a2-ba119e128948\",\n \"authorityType\": \"SERVICE\",\n \"principalId\": \"docs-example-caller\",\n \"issuedAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"authorization\": {\n \"authorizationId\": \"81a1c120-d296-458b-bbe5-824a8617f23a\",\n \"authorityId\": \"be8afa44-ee3c-44c2-a4a2-ba119e128948\",\n \"purpose\": \"API reference example: transactions endpoint\",\n \"issuedAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"intent\": {\n \"intentId\": \"ceb89d68-13ac-4ff9-b7b9-dd0e15637baa\",\n \"authorizationId\": \"81a1c120-d296-458b-bbe5-824a8617f23a\",\n \"action\": \"test:fixture-execute\",\n \"target\": \"vendor://payments\",\n \"parameters\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"createdAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"policy\": {\n \"name\": \"vendor-payment\",\n \"version\": \"2.0.0\",\n \"schemaVersion\": \"1.0.0\"\n },\n \"signals\": {\n \"vendorVerified\": true,\n \"invoiceVerified\": true,\n \"paymentApproved\": true,\n \"sufficientFunds\": true,\n \"paymentAmount\": 250,\n \"riskScore\": 5,\n \"vendorId\": \"vendor://payments\"\n }\n }'"},{"lang":"typescript","label":"TypeScript","source":"import { createBusinessTransaction, ParmanaClient } from \"@parmana/sdk\";\nimport { readFileSync } from \"node:fs\";\n\nconst client = new ParmanaClient({\n endpoint: \"https://parmana-api-real.vercel.app\",\n apiKey: process.env.PARMANA_API_KEY!,\n});\n\nconst inEffect = await client.policyInEffect(\"paytm:refund\");\n\n// The signed approval the approver sent, for this order and up to this amount.\nconst approval = JSON.parse(readFileSync(\"approval.json\", \"utf8\"));\n\nconst transaction = createBusinessTransaction({\n principalId: (await client.caller()).callerId,\n purpose: \"Refund order ORD-1042\",\n action: \"paytm:refund\",\n target: \"ORD-1042\",\n parameters: { orderId: \"ORD-1042\", transactionId: \"TXN-9\", amount: 750 },\n policy: inEffect.policy,\n signals: {\n refundEligible: true,\n fraudCheckPassed: true,\n refundAmount: 750,\n managerApproved: true,\n approvalArtifact: approval,\n },\n});\n\n// Declares only: the transaction is recorded as RECEIVED and nothing is released.\n// Release it with executeTransaction(declared.businessTransactionId).\nconst declared = await client.declareTransaction(transaction);\n\nconsole.log(declared.businessTransactionId, declared.status);"},{"lang":"python","label":"Python","source":"import json\nimport os\nfrom pathlib import Path\n\nfrom parmana import ParmanaClient, create_business_transaction\n\nclient = ParmanaClient(\n endpoint=\"https://parmana-api-real.vercel.app\",\n api_key=os.environ[\"PARMANA_API_KEY\"],\n)\n\nin_effect = client.policy_in_effect(\"erp:invoice-pay\")\n\n# The signed approval the approver sent, for this order and up to this amount.\napproval = json.loads(Path(\"approval.json\").read_text())\n\ntransaction = create_business_transaction(\n principal_id=client.caller().caller_id,\n purpose=\"Refund order ORD-1042\",\n action=\"erp:invoice-pay\",\n target=\"ORD-1042\",\n parameters={\"orderId\": \"ORD-1042\", \"transactionId\": \"TXN-9\", \"amount\": 750},\n policy=in_effect.policy,\n signals={\n \"refundEligible\": True,\n \"fraudCheckPassed\": True,\n \"refundAmount\": 750,\n \"managerApproved\": True,\n \"approvalArtifact\": approval,\n },\n)\n\n# Declares only: the transaction is recorded as RECEIVED and nothing is released.\n# Release it with client.execute_transaction(declared.business_transaction_id).\ndeclared = client.declare_transaction(transaction)\n\nprint(declared.business_transaction_id, declared.status)"}],"method":"post","type":"path","servers":["f200f6c4-872a-4370-9d36-b92bf244d5f1","9e1bbf67-a0a9-4aed-8dea-eea5cf6cfa2e"],"security":["3d005462-7db7-48e4-ace4-5bf08fc46c1f"],"path":"/transactions","baseUrlOptions":["https://parmana-api-real.vercel.app","http://localhost:3000"],"title":"Declare a Business Transaction","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X POST https://parmana-api-real.vercel.app/transactions \\\n -H \"Authorization: Bearer $PARMANA_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"businessTransactionId\": \"4cfe5661-42a6-4db0-8372-2d24dca235f2\",\n \"metadata\": {\n \"businessTransactionId\": \"4cfe5661-42a6-4db0-8372-2d24dca235f2\",\n \"sourceSystem\": \"docs-api-reference\",\n \"submittedBy\": \"docs-example\"\n },\n \"authority\": {\n \"authorityId\": \"be8afa44-ee3c-44c2-a4a2-ba119e128948\",\n \"authorityType\": \"SERVICE\",\n \"principalId\": \"docs-example-caller\",\n \"issuedAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"authorization\": {\n \"authorizationId\": \"81a1c120-d296-458b-bbe5-824a8617f23a\",\n \"authorityId\": \"be8afa44-ee3c-44c2-a4a2-ba119e128948\",\n \"purpose\": \"API reference example: transactions endpoint\",\n \"issuedAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"intent\": {\n \"intentId\": \"ceb89d68-13ac-4ff9-b7b9-dd0e15637baa\",\n \"authorizationId\": \"81a1c120-d296-458b-bbe5-824a8617f23a\",\n \"action\": \"test:fixture-execute\",\n \"target\": \"vendor://payments\",\n \"parameters\": {\n \"amount\": 250,\n \"currency\": \"USD\"\n },\n \"createdAt\": \"2026-09-14T17:18:27.000Z\"\n },\n \"policy\": {\n \"name\": \"vendor-payment\",\n \"version\": \"2.0.0\",\n \"schemaVersion\": \"1.0.0\"\n },\n \"signals\": {\n \"vendorVerified\": true,\n \"invoiceVerified\": true,\n \"paymentApproved\": true,\n \"sufficientFunds\": true,\n \"paymentAmount\": 250,\n \"riskScore\": 5,\n \"vendorId\": \"vendor://payments\"\n }\n }'"},{"label":"TypeScript","lang":"typescript","source":"import { createBusinessTransaction, ParmanaClient } from \"@parmana/sdk\";\nimport { readFileSync } from \"node:fs\";\n\nconst client = new ParmanaClient({\n endpoint: \"https://parmana-api-real.vercel.app\",\n apiKey: process.env.PARMANA_API_KEY!,\n});\n\nconst inEffect = await client.policyInEffect(\"paytm:refund\");\n\n// The signed approval the approver sent, for this order and up to this amount.\nconst approval = JSON.parse(readFileSync(\"approval.json\", \"utf8\"));\n\nconst transaction = createBusinessTransaction({\n principalId: (await client.caller()).callerId,\n purpose: \"Refund order ORD-1042\",\n action: \"paytm:refund\",\n target: \"ORD-1042\",\n parameters: { orderId: \"ORD-1042\", transactionId: \"TXN-9\", amount: 750 },\n policy: inEffect.policy,\n signals: {\n refundEligible: true,\n fraudCheckPassed: true,\n refundAmount: 750,\n managerApproved: true,\n approvalArtifact: approval,\n },\n});\n\n// Declares only: the transaction is recorded as RECEIVED and nothing is released.\n// Release it with executeTransaction(declared.businessTransactionId).\nconst declared = await client.declareTransaction(transaction);\n\nconsole.log(declared.businessTransactionId, declared.status);"},{"label":"Python","lang":"python","source":"import json\nimport os\nfrom pathlib import Path\n\nfrom parmana import ParmanaClient, create_business_transaction\n\nclient = ParmanaClient(\n endpoint=\"https://parmana-api-real.vercel.app\",\n api_key=os.environ[\"PARMANA_API_KEY\"],\n)\n\nin_effect = client.policy_in_effect(\"erp:invoice-pay\")\n\n# The signed approval the approver sent, for this order and up to this amount.\napproval = json.loads(Path(\"approval.json\").read_text())\n\ntransaction = create_business_transaction(\n principal_id=client.caller().caller_id,\n purpose=\"Refund order ORD-1042\",\n action=\"erp:invoice-pay\",\n target=\"ORD-1042\",\n parameters={\"orderId\": \"ORD-1042\", \"transactionId\": \"TXN-9\", \"amount\": 750},\n policy=in_effect.policy,\n signals={\n \"refundEligible\": True,\n \"fraudCheckPassed\": True,\n \"refundAmount\": 750,\n \"managerApproved\": True,\n \"approvalArtifact\": approval,\n },\n)\n\n# Declares only: the transaction is recorded as RECEIVED and nothing is released.\n# Release it with client.execute_transaction(declared.business_transaction_id).\ndeclared = client.declare_transaction(transaction)\n\nprint(declared.business_transaction_id, declared.status)"}],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.businessTransactionId":"ae94f2aa-6120-4c83-bf5d-7108e380d5a8","body.metadata.businessTransactionId":"ae94f2aa-6120-4c83-bf5d-7108e380d5a8","body.metadata.correlationId":"cc1ca975-4935-4e9a-a591-8897af6b56fb","body.metadata.sourceSystem":"docs-example","body.metadata.submittedBy":"docs-reader","body.metadata.submittedAt":"2026-07-13T17:36:00.835Z","body.authority.authorityId":"authority-1","body.authority.authorityType":"SERVICE","body.authority.principalId":"sandbox-visitor","body.authority.issuedAt":"2026-07-13T17:36:00.835Z","body.authorization.authorizationId":"authorization-1","body.authorization.authorityId":"authority-1","body.authorization.purpose":"Trying the Parmana sandbox","body.authorization.issuedAt":"2026-07-13T17:36:00.835Z","body.intent.intentId":"intent-1","body.intent.authorizationId":"authorization-1","body.intent.action":"sandbox:receipt","body.intent.target":"order-docs-example","body.intent.parameters":{"note":"hello"},"body.intent.createdAt":"2026-07-13T17:36:00.835Z","body.policy.name":"sandbox-receipt","body.policy.version":"1.0.0","body.policy.schemaVersion":"1.0.0","body.signals":{"note":"hello","receiptApproved":false}},{"body.businessTransactionId":"ffe803db-fb24-498a-9826-47ddc7e7167d","body.metadata.businessTransactionId":"ffe803db-fb24-498a-9826-47ddc7e7167d","body.metadata.correlationId":"303003bf-3939-407d-855d-ffb338532d6d","body.metadata.sourceSystem":"vendor-payment-service","body.metadata.submittedBy":"ap-automation","body.metadata.submittedAt":"2026-07-08T03:54:34.783Z","body.authority.authorityId":"05ff9e2e-e5dd-40aa-9964-02c2574396c9","body.authority.authorityType":"SERVICE","body.authority.principalId":"ap-automation-svc","body.authority.issuedAt":"2026-07-08T03:54:34.784Z","body.authority.displayName":"Accounts Payable Automation","body.authorization.authorizationId":"5fb16a24-6688-4f6f-98ee-53a117f0f2c9","body.authorization.authorityId":"05ff9e2e-e5dd-40aa-9964-02c2574396c9","body.authorization.purpose":"Authorize vendor payment disbursement","body.authorization.issuedAt":"2026-07-08T03:54:34.784Z","body.intent.intentId":"023fbdd4-f206-4a42-b7dd-d5f865fd2c74","body.intent.authorizationId":"5fb16a24-6688-4f6f-98ee-53a117f0f2c9","body.intent.action":"payments:execute","body.intent.target":"vendor/V-300","body.intent.parameters":{"amount":3300,"currency":"USD"},"body.intent.createdAt":"2026-07-08T03:54:34.784Z","body.policy.name":"vendor-payment","body.policy.version":"2.0.0","body.policy.schemaVersion":"1.0.0","body.signals":{"vendorVerified":true,"invoiceVerified":true,"paymentApproved":true,"sufficientFunds":true,"paymentAmount":3300,"riskScore":9}}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"title":"Transaction Create Request","description":"Request payload for POST /execute and POST /transactions. status and createdAt are assigned by Parmana and must not be supplied by the client. Validation performed identically by both endpoints (each has its own inline businessTransactionId UUID check, then shares BusinessTransactionMapper.fromRequest and BusinessTransactionValidator): metadata.businessTransactionId must equal businessTransactionId; authorization.authorityId must equal authority.authorityId; intent.authorizationId must equal authorization.authorizationId; policy.name, policy.version, and intent.action must each be non-empty. No other structural validation is performed: authority, authorization, intent, policy, and signals objects are otherwise passed through as supplied, including any additional properties.","type":"object","additionalProperties":true,"required":["businessTransactionId","metadata","authority","authorization","intent","policy","signals"],"properties":{"businessTransactionId":{"type":"string","format":"uuid","description":"Unique Business Transaction identifier. Must be a valid UUID on both POST /execute and POST /transactions (rejected with 400 otherwise).","isRequired":true,"uniqueKey":"businessTransactionId","typeLabel":"string\u003cuuid>"},"metadata":{"title":"Metadata","description":"Immutable Business Transaction metadata supplied by the calling application. Not evaluated by Policy. businessTransactionId is the only required field; it must match the top-level businessTransactionId. Parmana rejects a mismatch with a 400.","type":"object","additionalProperties":true,"required":["businessTransactionId"],"properties":{"businessTransactionId":{"type":"string","format":"uuid","description":"Unique Business Transaction identifier. Must be a valid UUID.","isRequired":true,"uniqueKey":"metadata.businessTransactionId","typeLabel":"string\u003cuuid>"},"correlationId":{"type":"string","description":"Optional correlation identifier used by the calling application.","uniqueKey":"metadata.correlationId","typeLabel":"string"},"tenantId":{"type":"string","description":"Optional tenant identifier for multi-tenant deployments.","uniqueKey":"metadata.tenantId","typeLabel":"string"},"sourceSystem":{"type":"string","description":"Originating application or service.","uniqueKey":"metadata.sourceSystem","typeLabel":"string"},"submittedBy":{"type":"string","description":"Identity of the calling application or principal.","uniqueKey":"metadata.submittedBy","typeLabel":"string"},"submittedAt":{"type":"string","format":"date-time","description":"UTC timestamp when the Business Transaction was submitted.","uniqueKey":"metadata.submittedAt","typeLabel":"string\u003cdate-time>"}},"examples":[{"businessTransactionId":"eed2a972-1bf5-4166-8472-761f76fbf1b2","correlationId":"6b97caca-1605-4711-bf00-7e5a65434d93","sourceSystem":"vendor-payment-service","submittedBy":"ap-automation","submittedAt":"2026-07-07T16:38:59.285Z"}],"isRequired":true,"uniqueKey":"metadata","typeLabel":"Metadata · object"},"authority":{"title":"Authority","description":"Entity empowered to authorize execution within a trust domain. Immutable once issued.","type":"object","additionalProperties":true,"required":["authorityId","authorityType","principalId","issuedAt"],"properties":{"authorityId":{"type":"string","description":"Unique Authority identifier.","isRequired":true,"uniqueKey":"authority.authorityId","typeLabel":"string"},"authorityType":{"type":"string","description":"Type of authority.","enum":["USER","ROLE","SERVICE","ORGANIZATION"],"isRequired":true,"uniqueKey":"authority.authorityType","typeLabel":"enum\u003cstring>"},"principalId":{"type":"string","description":"Principal identifier.","isRequired":true,"uniqueKey":"authority.principalId","typeLabel":"string"},"issuedAt":{"type":"string","format":"date-time","description":"UTC timestamp when Authority became effective.","isRequired":true,"uniqueKey":"authority.issuedAt","typeLabel":"string\u003cdate-time>"},"displayName":{"type":"string","description":"Human-readable display name.","uniqueKey":"authority.displayName","typeLabel":"string"}},"examples":[{"authorityId":"c0c01c23-04a2-45f2-a821-ef24bfca02d3","authorityType":"SERVICE","principalId":"ap-automation-svc","displayName":"Accounts Payable Automation","issuedAt":"2026-07-07T16:38:59.285Z"}],"isRequired":true,"uniqueKey":"authority","typeLabel":"Authority · object"},"authorization":{"title":"Authorization","description":"Immutable trust artifact proving that an Authority granted approval for an intended execution.","type":"object","additionalProperties":true,"required":["authorizationId","authorityId","purpose","issuedAt"],"properties":{"authorizationId":{"type":"string","description":"Unique Authorization identifier.","isRequired":true,"uniqueKey":"authorization.authorizationId","typeLabel":"string"},"authorityId":{"type":"string","description":"Authority issuing this Authorization. Must match authority.authorityId. Parmana rejects a mismatch with a 400.","isRequired":true,"uniqueKey":"authorization.authorityId","typeLabel":"string"},"purpose":{"type":"string","description":"Business purpose for which the Authorization was granted.","isRequired":true,"uniqueKey":"authorization.purpose","typeLabel":"string"},"issuedAt":{"type":"string","format":"date-time","description":"UTC timestamp when the Authorization was issued.","isRequired":true,"uniqueKey":"authorization.issuedAt","typeLabel":"string\u003cdate-time>"},"expiresAt":{"type":"string","format":"date-time","description":"Optional expiration timestamp. After this time the Authorization is no longer valid.","uniqueKey":"authorization.expiresAt","typeLabel":"string\u003cdate-time>"}},"examples":[{"authorizationId":"6e9d6aa6-6d20-40a8-b05d-383516365cc7","authorityId":"c0c01c23-04a2-45f2-a821-ef24bfca02d3","purpose":"Authorize vendor payment disbursement","issuedAt":"2026-07-07T16:38:59.285Z"}],"isRequired":true,"uniqueKey":"authorization","typeLabel":"Authorization · object"},"intent":{"title":"Intent","description":"Immutable declaration of the action an Authority intends to be executed under an Authorization.","type":"object","additionalProperties":true,"required":["intentId","authorizationId","action","target","parameters","createdAt"],"properties":{"intentId":{"type":"string","description":"Unique Intent identifier.","isRequired":true,"uniqueKey":"intent.intentId","typeLabel":"string"},"authorizationId":{"type":"string","description":"Authorization under which this Intent was created. Must match authorization.authorizationId. Parmana rejects a mismatch with a 400.","isRequired":true,"uniqueKey":"intent.authorizationId","typeLabel":"string"},"action":{"type":"string","description":"Business action being requested. Required and non-empty. Parmana rejects an empty action with a 400.","examples":["VendorPayment","TransferFunds","DeployApplication"],"isRequired":true,"uniqueKey":"intent.action","typeLabel":"string"},"target":{"type":"string","description":"Target of the intended action.","examples":["vendor/V-100","account/12345"],"isRequired":true,"uniqueKey":"intent.target","typeLabel":"string"},"parameters":{"type":"object","description":"Immutable business parameters describing the intended action. Not evaluated by policy, see signals.","additionalProperties":true,"isRequired":true,"uniqueKey":"intent.parameters","typeLabel":"object"},"createdAt":{"type":"string","format":"date-time","description":"UTC timestamp when the Intent was created.","isRequired":true,"uniqueKey":"intent.createdAt","typeLabel":"string\u003cdate-time>"}},"examples":[{"intentId":"ae5865f6-181b-409a-90ec-1b4b8b8414ba","authorizationId":"6e9d6aa6-6d20-40a8-b05d-383516365cc7","action":"payments:execute","target":"vendor/V-100","parameters":{"amount":4500,"currency":"USD"},"createdAt":"2026-07-07T16:38:59.285Z"}],"isRequired":true,"uniqueKey":"intent","typeLabel":"Intent · object"},"policy":{"title":"Policy Reference","description":"Exact Policy to evaluate. The client explicitly supplies name, version, and schemaVersion; Parmana does not automatically discover or select a policy. If no matching policy file exists at policies/{name}/{version}/policy.json, the request fails with a 404 (policyId/policyVersion on POST /policies/validate) or a RUNTIME_ERROR (name/version elsewhere, from PolicyNotFoundError not otherwise mapped by the shared error handler in every route, see the error envelope note).","type":"object","additionalProperties":true,"required":["name","version","schemaVersion"],"properties":{"name":{"type":"string","description":"Policy name. Required and non-empty. Parmana rejects an empty name with a 400.","minLength":1,"isRequired":true,"uniqueKey":"policy.name","typeLabel":"string"},"version":{"type":"string","description":"Business policy version. Required and non-empty. Parmana rejects an empty version with a 400.","minLength":1,"examples":["2.0.0","1.0.0"],"isRequired":true,"uniqueKey":"policy.version","typeLabel":"string"},"schemaVersion":{"type":"string","description":"Signals schema version expected by the policy.","examples":["1.0.0"],"isRequired":true,"uniqueKey":"policy.schemaVersion","typeLabel":"string"},"contentHash":{"type":"string","description":"sha256 of the canonicalized policy.json content actually loaded for this decision (G-24). Server-computed, never caller-settable; absent on a request-supplied PolicyReference and on a PolicyReference built before this field existed. Only present on the copy embedded in an Execution Trust Record's transaction.policy.","uniqueKey":"policy.contentHash","typeLabel":"string"},"governanceAnchor":{"type":"object","description":"Whether the policy content above is traceable to a completed Policy Governance approval, resolved at decision time (G-45). Absent on a PolicyReference built before this field existed. Its presence does not imply POLICY_EXECUTION_VERIFICATION_ENFORCED is on -- only that the lookup ran and recorded what it found, which may honestly be \"no approval record exists for this policy yet.\"","additionalProperties":false,"required":["status"],"properties":{"status":{"type":"string","enum":["VERIFIED","NO_APPROVAL_RECORD","SIGNATURE_INVALID","CONTENT_MISMATCH"],"isRequired":true,"uniqueKey":"policy.governanceAnchor.status","typeLabel":"enum\u003cstring>"},"approvalRecordId":{"type":"string","description":"The PolicyChangeApprovalRecord this anchor resolved against. Present only when a record was found at all -- absent for NO_APPROVAL_RECORD.","uniqueKey":"policy.governanceAnchor.approvalRecordId","typeLabel":"string"}},"uniqueKey":"policy.governanceAnchor","typeLabel":"object"}},"examples":[{"name":"vendor-payment","version":"2.0.0","schemaVersion":"1.0.0"},{"name":"vendor-payment","version":"2.0.0","schemaVersion":"1.0.0","contentHash":"3f2504e04f8964e7ad0dbb0cf7fea1b4e0e1e0a3a1e1a4b6c8e0d5f6a7b8c9d0","governanceAnchor":{"status":"NO_APPROVAL_RECORD"}}],"isRequired":true,"uniqueKey":"policy","typeLabel":"Policy Reference · object"},"signals":{"title":"Signals","description":"Opaque runtime facts evaluated by the resolved Policy's rules. Parmana assigns no business meaning to these values and does not statically validate them beyond the Policy's own signalsSchema declaration (see policies/{name}/{version}/policy.json). Scaled integers, not floats, for numeric signals such as amounts (house convention across every reference policy).","type":"object","additionalProperties":true,"examples":[{"vendorVerified":true,"invoiceVerified":true,"paymentApproved":true,"sufficientFunds":true,"paymentAmount":4500,"riskScore":10}],"isRequired":true,"uniqueKey":"signals","typeLabel":"Signals · object"}},"examples":[{"businessTransactionId":"eed2a972-1bf5-4166-8472-761f76fbf1b2","metadata":{"businessTransactionId":"eed2a972-1bf5-4166-8472-761f76fbf1b2","correlationId":"6b97caca-1605-4711-bf00-7e5a65434d93","sourceSystem":"vendor-payment-service","submittedBy":"ap-automation","submittedAt":"2026-07-07T16:38:59.285Z"},"authority":{"authorityId":"c0c01c23-04a2-45f2-a821-ef24bfca02d3","authorityType":"SERVICE","principalId":"ap-automation-svc","displayName":"Accounts Payable Automation","issuedAt":"2026-07-07T16:38:59.285Z"},"authorization":{"authorizationId":"6e9d6aa6-6d20-40a8-b05d-383516365cc7","authorityId":"c0c01c23-04a2-45f2-a821-ef24bfca02d3","purpose":"Authorize vendor payment disbursement","issuedAt":"2026-07-07T16:38:59.285Z"},"intent":{"intentId":"ae5865f6-181b-409a-90ec-1b4b8b8414ba","authorizationId":"6e9d6aa6-6d20-40a8-b05d-383516365cc7","action":"payments:execute","target":"vendor/V-100","parameters":{"amount":4500,"currency":"USD"},"createdAt":"2026-07-07T16:38:59.285Z"},"policy":{"name":"vendor-payment","version":"2.0.0","schemaVersion":"1.0.0"},"signals":{"vendorVerified":true,"invoiceVerified":true,"paymentApproved":true,"sufficientFunds":true,"paymentAmount":4500,"riskScore":10}}],"uniqueKey":"","typeLabel":"Transaction Create Request · object"},"examples":{"sandbox-receipt":{"title":"sandbox-receipt","summary":"The public sandbox's receipt action, sent without an approval. The sandbox refuses it (403 POLICY_DENIED). Get a demo approval from POST /sandbox/approvals for the same target and add it to signals to release it.","value":{"businessTransactionId":"ae94f2aa-6120-4c83-bf5d-7108e380d5a8","metadata":{"businessTransactionId":"ae94f2aa-6120-4c83-bf5d-7108e380d5a8","correlationId":"cc1ca975-4935-4e9a-a591-8897af6b56fb","sourceSystem":"docs-example","submittedBy":"docs-reader","submittedAt":"2026-07-13T17:36:00.835Z"},"authority":{"authorityId":"authority-1","authorityType":"SERVICE","principalId":"sandbox-visitor","issuedAt":"2026-07-13T17:36:00.835Z"},"authorization":{"authorizationId":"authorization-1","authorityId":"authority-1","purpose":"Trying the Parmana sandbox","issuedAt":"2026-07-13T17:36:00.835Z"},"intent":{"intentId":"intent-1","authorizationId":"authorization-1","action":"sandbox:receipt","target":"order-docs-example","parameters":{"note":"hello"},"createdAt":"2026-07-13T17:36:00.835Z"},"policy":{"name":"sandbox-receipt","version":"1.0.0","schemaVersion":"1.0.0"},"signals":{"note":"hello","receiptApproved":false}}},"vendor-payment-flow-transactions-endpoint":{"title":"vendor-payment-flow-transactions-endpoint","summary":"Real captured request (vendor-payment 2.0.0, APPROVED), includes a client-supplied status and an unrecognized top-level field to demonstrate both are rejected/dropped, never persisted (see the 201 response below)","value":{"businessTransactionId":"ffe803db-fb24-498a-9826-47ddc7e7167d","metadata":{"businessTransactionId":"ffe803db-fb24-498a-9826-47ddc7e7167d","correlationId":"303003bf-3939-407d-855d-ffb338532d6d","sourceSystem":"vendor-payment-service","submittedBy":"ap-automation","submittedAt":"2026-07-08T03:54:34.783Z"},"authority":{"authorityId":"05ff9e2e-e5dd-40aa-9964-02c2574396c9","authorityType":"SERVICE","principalId":"ap-automation-svc","displayName":"Accounts Payable Automation","issuedAt":"2026-07-08T03:54:34.784Z"},"authorization":{"authorizationId":"5fb16a24-6688-4f6f-98ee-53a117f0f2c9","authorityId":"05ff9e2e-e5dd-40aa-9964-02c2574396c9","purpose":"Authorize vendor payment disbursement","issuedAt":"2026-07-08T03:54:34.784Z"},"intent":{"intentId":"023fbdd4-f206-4a42-b7dd-d5f865fd2c74","authorizationId":"5fb16a24-6688-4f6f-98ee-53a117f0f2c9","action":"payments:execute","target":"vendor/V-300","parameters":{"amount":3300,"currency":"USD"},"createdAt":"2026-07-08T03:54:34.784Z"},"policy":{"name":"vendor-payment","version":"2.0.0","schemaVersion":"1.0.0"},"signals":{"vendorVerified":true,"invoiceVerified":true,"paymentApproved":true,"sufficientFunds":true,"paymentAmount":3300,"riskScore":9},"status":"APPROVED","unexpectedField":"should-not-be-persisted"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"95c4acbc-b1dd-4cab-960b-f145c11276e7":{"description":"Accepted and recorded as RECEIVED. Nothing has been released.","content":{"application/json":{"schema":{"type":"object","required":["businessTransactionId","status","transaction"],"properties":{"businessTransactionId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"businessTransactionId","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["RECEIVED"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"transaction":{"type":"object","description":"The Business Transaction as stored.","isRequired":true,"uniqueKey":"transaction","typeLabel":"object"},"acceptedAt":{"type":"string","format":"date-time","uniqueKey":"acceptedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"businessTransactionId":"9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90","status":"RECEIVED","acceptedAt":"2026-11-15T10:00:00.000Z","transaction":{"businessTransactionId":"9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90","intent":{"action":"sandbox:receipt","target":"order-docs-example"}}},"examples":{"Example":{"title":"Example","value":{"businessTransactionId":"9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90","status":"RECEIVED","acceptedAt":"2026-11-15T10:00:00.000Z","transaction":{"businessTransactionId":"9b2c4f1e-3d7a-4e8b-9f10-2a6c5d7e8f90","intent":{"action":"sandbox:receipt","target":"order-docs-example"}}}}},"exampleType":"examples"}},"exampleType":"examples"},"53eced25-9a82-4b6b-8f5a-6b227b7c152b":{"description":"The request is malformed and nothing was stored. The same checks as `POST /execute`.","content":{"application/json":{"schema":{"title":"Error Response","description":"Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog.","type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError.","examples":["RUNTIME_ERROR","VERIFICATION_FAILED","RECEIPT_GENERATION_FAILED","POLICY_DENIED","CAPABILITY_NOT_ALLOWED","RATE_LIMITED","AUDIT_UNAVAILABLE","SIGNING_UNAVAILABLE","CONNECTOR_NOT_REGISTERED","EXECUTION_RECORD_INCOMPLETE","EXECUTION_INTENT_UNAVAILABLE","EXECUTION_INTENT_RESULT_NOT_RECORDED","EXECUTION_INTENT_NOT_FOUND","EXECUTION_INTENTS_NOT_ENABLED","EXECUTION_INTENT_NOT_RESOLVABLE","EXECUTION_INTENT_RESOLUTION_INVALID","NON_HUMAN_CALLER_DENIED","EXECUTION_OUTCOME_UNKNOWN","AUTHORIZATION_NO_LONGER_VALID"],"uniqueKey":"code","typeLabel":"string"},"executionStatus":{"type":"string","enum":["EXECUTION_UNKNOWN","NOT_EXECUTED"],"description":"RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent.","uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"}},"examples":[{"error":"businessTransactionId must be a valid UUID."},{"error":"Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists."},{"error":"Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold.","code":"RUNTIME_ERROR"}],"uniqueKey":"","typeLabel":"Error Response · object"},"examples":{"badUuid":{"title":"badUuid","summary":"Real captured response, malformed businessTransactionId","value":{"error":"businessTransactionId must be a valid UUID."}},"invariantMismatch":{"title":"invariantMismatch","summary":"Real captured response, authorization.authorityId does not match authority.authorityId","value":{"error":"authorization.authorityId must match authority.authorityId."}}},"exampleType":"examples"}},"exampleType":"examples"},"e102ef17-7aa0-4988-bed5-70b4a4c1a71c":{"description":"The `Authorization` header is missing, is not a bearer key, or names a key the server does not know. Nothing ran. Send a valid key.","content":{"application/json":{"schema":{"title":"Error Response","description":"Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog.","type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError.","examples":["RUNTIME_ERROR","VERIFICATION_FAILED","RECEIPT_GENERATION_FAILED","POLICY_DENIED","CAPABILITY_NOT_ALLOWED","RATE_LIMITED","AUDIT_UNAVAILABLE","SIGNING_UNAVAILABLE","CONNECTOR_NOT_REGISTERED","EXECUTION_RECORD_INCOMPLETE","EXECUTION_INTENT_UNAVAILABLE","EXECUTION_INTENT_RESULT_NOT_RECORDED","EXECUTION_INTENT_NOT_FOUND","EXECUTION_INTENTS_NOT_ENABLED","EXECUTION_INTENT_NOT_RESOLVABLE","EXECUTION_INTENT_RESOLUTION_INVALID","NON_HUMAN_CALLER_DENIED","EXECUTION_OUTCOME_UNKNOWN","AUTHORIZATION_NO_LONGER_VALID"],"uniqueKey":"code","typeLabel":"string"},"executionStatus":{"type":"string","enum":["EXECUTION_UNKNOWN","NOT_EXECUTED"],"description":"RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent.","uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"}},"examples":[{"error":"businessTransactionId must be a valid UUID."},{"error":"Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists."},{"error":"Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold.","code":"RUNTIME_ERROR"}],"uniqueKey":"","typeLabel":"Error Response · object"},"examples":{"authRequired":{"title":"authRequired","summary":"Real captured response, missing or invalid Authorization header","value":{"error":"authentication required"}}},"exampleType":"examples"}},"exampleType":"examples"},"52adeec1-a630-4601-8350-3a714bd49521":{"description":"The caller is not permitted to assert this authority.principalId, to act for this tenantId, or to invoke this capability.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"string","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Caller is not permitted to invoke this capability.","code":"CAPABILITY_NOT_ALLOWED"},"examples":{"Example":{"title":"Example","value":{"error":"Caller is not permitted to invoke this capability.","code":"CAPABILITY_NOT_ALLOWED"}}},"exampleType":"examples"}},"exampleType":"examples"},"ef8704fb-7eea-424f-9c94-bed81e79be83":{"description":"This `businessTransactionId` was already used. Nothing ran again.","content":{"application/json":{"schema":{"title":"Error Response","description":"Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog.","type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError.","examples":["RUNTIME_ERROR","VERIFICATION_FAILED","RECEIPT_GENERATION_FAILED","POLICY_DENIED","CAPABILITY_NOT_ALLOWED","RATE_LIMITED","AUDIT_UNAVAILABLE","SIGNING_UNAVAILABLE","CONNECTOR_NOT_REGISTERED","EXECUTION_RECORD_INCOMPLETE","EXECUTION_INTENT_UNAVAILABLE","EXECUTION_INTENT_RESULT_NOT_RECORDED","EXECUTION_INTENT_NOT_FOUND","EXECUTION_INTENTS_NOT_ENABLED","EXECUTION_INTENT_NOT_RESOLVABLE","EXECUTION_INTENT_RESOLUTION_INVALID","NON_HUMAN_CALLER_DENIED","EXECUTION_OUTCOME_UNKNOWN","AUTHORIZATION_NO_LONGER_VALID"],"uniqueKey":"code","typeLabel":"string"},"executionStatus":{"type":"string","enum":["EXECUTION_UNKNOWN","NOT_EXECUTED"],"description":"RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent.","uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"}},"examples":[{"error":"businessTransactionId must be a valid UUID."},{"error":"Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists."},{"error":"Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold.","code":"RUNTIME_ERROR"}],"uniqueKey":"","typeLabel":"Error Response · object"},"examples":{"duplicate":{"title":"duplicate","summary":"Real captured response","value":{"error":"Business Transaction '1a341e62-18de-408e-9b34-89aec901dae5' already exists."}}},"exampleType":"examples"}},"exampleType":"examples"},"1bf155e4-7407-492c-a083-a1833075a9d2":{"description":"Too many requests from this caller on this route in the last minute. The default limits are 30 per caller per minute on `/execute`, 300 per IP address on `/health` and `/ready`, and 60 per IP address shared by the unauthenticated verification and handbook routes. The request never reached the handler, so nothing was recorded or executed. Wait the number of seconds in the `Retry-After` header, then retry.","headers":{"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"type":"integer"}}},"content":{"application/json":{"schema":{"title":"Error Response","description":"Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog.","type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError.","examples":["RUNTIME_ERROR","VERIFICATION_FAILED","RECEIPT_GENERATION_FAILED","POLICY_DENIED","CAPABILITY_NOT_ALLOWED","RATE_LIMITED","AUDIT_UNAVAILABLE","SIGNING_UNAVAILABLE","CONNECTOR_NOT_REGISTERED","EXECUTION_RECORD_INCOMPLETE","EXECUTION_INTENT_UNAVAILABLE","EXECUTION_INTENT_RESULT_NOT_RECORDED","EXECUTION_INTENT_NOT_FOUND","EXECUTION_INTENTS_NOT_ENABLED","EXECUTION_INTENT_NOT_RESOLVABLE","EXECUTION_INTENT_RESOLUTION_INVALID","NON_HUMAN_CALLER_DENIED","EXECUTION_OUTCOME_UNKNOWN","AUTHORIZATION_NO_LONGER_VALID"],"uniqueKey":"code","typeLabel":"string"},"executionStatus":{"type":"string","enum":["EXECUTION_UNKNOWN","NOT_EXECUTED"],"description":"RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent.","uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"}},"examples":[{"error":"businessTransactionId must be a valid UUID."},{"error":"Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists."},{"error":"Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold.","code":"RUNTIME_ERROR"}],"uniqueKey":"","typeLabel":"Error Response · object"},"examples":{"rateLimited":{"title":"rateLimited","summary":"Rate limit exceeded","value":{"error":"Rate limit exceeded. Try again later.","code":"RATE_LIMITED"}}},"exampleType":"examples"}},"exampleType":"examples"},"8e43145b-4dd1-4f50-9523-de9697bab2b2":{"description":"`EXECUTION_RECORD_INCOMPLETE`: released, but the signed record could not be produced. Do not resend; an operator finalizes it. See `POST /execute`.","content":{"application/json":{"schema":{"title":"Error Response","description":"Shared error envelope produced by packages/api/src/middleware/error-handler.ts and by every route's inline validation checks. error is always a plain human-readable string (never a nested object). code is present only when the failure was a RuntimeError subclass reaching the centralized error handler (VerificationFailedError, ReceiptGenerationError, or an uncategorized RuntimeError); it is absent from every inline route-level check (businessTransactionId format/required checks) and from BusinessTransactionValidationError, PolicyValidationError, SignalValidationError, PolicyNotFoundError, DuplicateBusinessTransactionError, and the generic 500 fallback. POST /policies/validate does NOT use this envelope at all. See its own response schema. For the triggering condition and recommended caller action behind any specific error/code/status combination, see the Error catalog at /api-reference/error-catalog.","type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Stable machine-readable error code. Only present for errors that reach the handler as a RuntimeError.","examples":["RUNTIME_ERROR","VERIFICATION_FAILED","RECEIPT_GENERATION_FAILED","POLICY_DENIED","CAPABILITY_NOT_ALLOWED","RATE_LIMITED","AUDIT_UNAVAILABLE","SIGNING_UNAVAILABLE","CONNECTOR_NOT_REGISTERED","EXECUTION_RECORD_INCOMPLETE","EXECUTION_INTENT_UNAVAILABLE","EXECUTION_INTENT_RESULT_NOT_RECORDED","EXECUTION_INTENT_NOT_FOUND","EXECUTION_INTENTS_NOT_ENABLED","EXECUTION_INTENT_NOT_RESOLVABLE","EXECUTION_INTENT_RESOLUTION_INVALID","NON_HUMAN_CALLER_DENIED","EXECUTION_OUTCOME_UNKNOWN","AUTHORIZATION_NO_LONGER_VALID"],"uniqueKey":"code","typeLabel":"string"},"executionStatus":{"type":"string","enum":["EXECUTION_UNKNOWN","NOT_EXECUTED"],"description":"RFC-0023 phase 4. EXECUTION_UNKNOWN with EXECUTION_OUTCOME_UNKNOWN: the action was released and the call failed, so whether it ran is unknown; never reported as failed, and the Execution Intent stays ERRORED until a person resolves it. NOT_EXECUTED with AUTHORIZATION_NO_LONGER_VALID: the release was refused because a business condition or the authority grant it rested on no longer held, and nothing was sent.","uniqueKey":"executionStatus","typeLabel":"enum\u003cstring>"}},"examples":[{"error":"businessTransactionId must be a valid UUID."},{"error":"Business Transaction 'eed2a972-1bf5-4166-8472-761f76fbf1b2' already exists."},{"error":"Execution rejected: Vendor payment rejected because the assessed payment risk exceeds the maximum permitted threshold.","code":"RUNTIME_ERROR"}],"uniqueKey":"","typeLabel":"Error Response · object"},"examples":{"executionRecordIncomplete":{"title":"executionRecordIncomplete","summary":"The action was released but its signed record could not be produced","value":{"error":"The action for business transaction 'e54187e6-431f-4e1c-9c0e-ff2cb5d6d40a' was released to the execution system, but its signed Execution Trust Record could not be produced. Do not retry as a new transaction: reconcile against the connector and the execution audit events for this businessTransactionId. authorizationId: 381ef27a-0955-4085-9e5d-e4223fef2986.","code":"EXECUTION_RECORD_INCOMPLETE"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3d005462-7db7-48e4-ace4-5bf08fc46c1f":{"bearerAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer \u003ckey>. Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.\n","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"f200f6c4-872a-4370-9d36-b92bf244d5f1":{"url":"https://parmana-api-real.vercel.app","description":"Production. Needs a key issued by the operator."},"9e1bbf67-a0a9-4aed-8dea-eea5cf6cfa2e":{"url":"http://localhost:3000","description":"Local (packages/api, PORT env var, default 3000)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"Authorization","description":"Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer \u003ckey>. Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.\n","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Authorization","type":"string","description":"Caller API key issued by scripts/generate-api-key.ts. Sent as Authorization: Bearer \u003ckey>. Verified against a stored SHA-256 hash in constant time by packages/api/src/auth/StaticKeyAuthenticator.ts. Required on every route not listed as exempt in this document's top-level description. See /api-reference/authentication.\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi.bundled.yaml"},"subdomain":"parmanasystems","siteName":"Parmana","title":"Declare a Business Transaction - Parmana","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-15T12:55:14.995Z","originalFileLocation":"api-reference/endpoints/create-transaction.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Declares a Business Transaction: it is checked, accepted and recorded with the status RECEIVED.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Parmana\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Declare a Business Transaction - Parmana\">\u003cmeta data-mint-head property=\"og:description\" content=\"Declares a Business Transaction: it is checked, accepted and recorded with the status RECEIVED.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Parmana\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://parmanasystems.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Declare+a+Business+Transaction\u0026amp;description=Declares+a+Business+Transaction%3A+it+is+checked%2C+accepted+and+recorded+with+the+status+%60RECEIVED%60.\u0026amp;theme=290f8f9940b83ce8c15e998b\u0026amp;signature=ba54993e5d6105b916db2ec73846a3677c0698ae81110065ae70127428e06354\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Declare a Business Transaction - Parmana\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Declares a Business Transaction: it is checked, accepted and recorded with the status RECEIVED.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://parmanasystems.mintlify.site/_mintlify/api/og/v2?division=Transactions\u0026amp;title=Declare+a+Business+Transaction\u0026amp;description=Declares+a+Business+Transaction%3A+it+is+checked%2C+accepted+and+recorded+with+the+status+%60RECEIVED%60.\u0026amp;theme=290f8f9940b83ce8c15e998b\u0026amp;signature=ba54993e5d6105b916db2ec73846a3677c0698ae81110065ae70127428e06354\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/parmanasystems/etjcJguz6BN6OG2a/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Parmana\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366F1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoints/create-transaction.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.parmanasystems.com/#organization\",\"name\":\"Parmana\",\"url\":\"https://docs.parmanasystems.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/parmanasystems/3fc1F82PB1uU1_pD/logo/logo-light.svg?fit=max\u0026auto=format\u0026n=3fc1F82PB1uU1_pD\u0026q=85\u0026s=902f62a6181def8e3c6b5aa71a40d247\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.parmanasystems.com#website\",\"name\":\"Parmana\",\"url\":\"https://docs.parmanasystems.com\",\"publisher\":{\"@id\":\"https://docs.parmanasystems.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction#webpage\",\"url\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction\",\"name\":\"Declare a Business Transaction\",\"description\":\"Declares a Business Transaction: it is checked, accepted and recorded with the status RECEIVED.\",\"dateModified\":\"2026-11-15T12:55:14.995Z\",\"isPartOf\":{\"@id\":\"https://docs.parmanasystems.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Transactions\",\"item\":\"https://docs.parmanasystems.com/api-reference/endpoints/list-transactions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Declare a Business Transaction\",\"item\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction#apireference\",\"headline\":\"Declare a Business Transaction\",\"name\":\"Declare a Business Transaction\",\"description\":\"Declares a Business Transaction: it is checked, accepted and recorded with the status RECEIVED.\",\"url\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction\",\"mainEntityOfPage\":{\"@id\":\"https://docs.parmanasystems.com/api-reference/endpoints/create-transaction#webpage\"},\"dateModified\":\"2026-11-15T12:55:14.995Z\",\"publisher\":{\"@id\":\"https://docs.parmanasystems.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.parmanasystems.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Parmana\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Parmana\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoints/create-transaction.md","siteName":"Parmana","nav":{"global":null,"tabs":[{"tab":"Get started","pages":[{"title":"Get started","href":""}]},{"tab":"Concepts","pages":[{"title":"Concepts","href":"/concepts/policies-and-the-decision"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/cli/quickstart"}]},{"tab":"TypeScript SDK","pages":[{"title":"TypeScript SDK","href":"/sdks/typescript"}]},{"tab":"Python SDK","pages":[{"title":"Python SDK","href":"/sdks/python"}]},{"tab":"Connector SDKs","pages":[{"title":"Connector SDKs","href":"/integrations/overview"}]},{"tab":"REST API","groups":[{"group":"REST API guide","pages":[{"title":"REST API Introduction","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Error Handling","href":"/api-reference/error-handling"},{"title":"Idempotency and Nonces","href":"/api-reference/idempotency-and-nonces"},{"title":"Error Catalog","href":"/api-reference/error-catalog"},{"title":"SDK coverage of the API","href":"/sdks/api-coverage"}]},{"group":"Execution","pages":[{"title":"Execute a Business Transaction","openapi":"openapi.bundled.yaml POST /execute","href":"/api-reference/endpoints/execute-transaction"}]},{"group":"Transactions","pages":[{"title":"List Business Transactions","description":"Lists the Business Transactions your key submitted, as a bare array with no paging metadata.","openapi":"openapi.bundled.yaml GET /transactions","href":"/api-reference/endpoints/list-transactions"},{"title":"Declare a Business Transaction","openapi":"openapi.bundled.yaml POST /transactions","href":"/api-reference/endpoints/create-transaction"},{"title":"Get Business Transaction","description":"Returns one Business Transaction as it was stored.","openapi":"openapi.bundled.yaml GET /transactions/{businessTransactionId}","href":"/api-reference/endpoints/get-transaction"},{"title":"Execute a declared Business Transaction","openapi":"openapi.bundled.yaml POST /transactions/{businessTransactionId}/execute","href":"/api-reference/endpoints/execute-declared-transaction"},{"title":"Get the status of a Business Transaction","openapi":"openapi.bundled.yaml GET /transactions/{businessTransactionId}/status","href":"/api-reference/endpoints/get-transaction-status"},{"title":"Reconcile a Business Transaction whose outcome is pending","openapi":"openapi.bundled.yaml POST /transactions/{businessTransactionId}/reconcile","href":"/api-reference/endpoints/reconcile-transaction"}]},{"group":"Verification","pages":[{"title":"Verify an Execution Trust Record","openapi":"openapi.bundled.yaml POST /verify","href":"/api-reference/endpoints/verify-transaction"},{"title":"Get latest Verification","openapi":"openapi.bundled.yaml GET /verification/{businessTransactionId}","href":"/api-reference/endpoints/get-latest-verification"}]},{"group":"Receipts","pages":[{"title":"Generate a Receipt","openapi":"openapi.bundled.yaml POST /receipt","href":"/api-reference/endpoints/generate-receipt"},{"title":"Get latest Receipt","openapi":"openapi.bundled.yaml GET /receipt/latest/{businessTransactionId}","href":"/api-reference/endpoints/get-latest-receipt"}]},{"group":"Trust Records","pages":[{"title":"Bulk-export Execution Trust Records (compliance/audit)","openapi":"openapi.bundled.yaml GET /trust-records","href":"/api-reference/endpoints/list-trust-records"},{"title":"Get Execution Trust Record","openapi":"openapi.bundled.yaml GET /trust-records/{businessTransactionId}","href":"/api-reference/endpoints/get-trust-record"}]},{"group":"Replay","pages":[{"title":"Replay an Execution Trust Record","openapi":"openapi.bundled.yaml POST /replay","href":"/api-reference/endpoints/replay-transaction"}]},{"group":"Policies","pages":[{"title":"Get the policy a capability's requests must declare right now","openapi":"openapi.bundled.yaml GET /policies/in-effect","href":"/api-reference/endpoints/get-policy-in-effect"},{"title":"Validate that a Policy exists and is readable","openapi":"openapi.bundled.yaml POST /policies/validate","href":"/api-reference/endpoints/validate-policy"}]},{"group":"Policy Governance","pages":[{"title":"Propose a policy change (maker)","openapi":"openapi.bundled.yaml POST /policies/{name}/{version}/pending-changes","href":"/api-reference/endpoints/propose-policy-change"},{"title":"List pending policy changes (maker-checker)","openapi":"openapi.bundled.yaml GET /policies/pending-changes","href":"/api-reference/endpoints/list-pending-policy-changes"},{"title":"Approve a pending policy change (checker)","openapi":"openapi.bundled.yaml POST /policies/pending-changes/{id}/approve","href":"/api-reference/endpoints/approve-policy-change"},{"title":"Reject a pending policy change (checker)","openapi":"openapi.bundled.yaml POST /policies/pending-changes/{id}/reject","href":"/api-reference/endpoints/reject-policy-change"}]},{"group":"Approvers","pages":[{"title":"List approver keys","openapi":"openapi.bundled.yaml GET /approval-issuers","href":"/api-reference/endpoints/list-approval-issuers"},{"title":"List approver changes","openapi":"openapi.bundled.yaml GET /approval-issuers/changes","href":"/api-reference/endpoints/list-approval-issuer-changes"},{"title":"Propose adding or revoking an approver key","openapi":"openapi.bundled.yaml POST /approval-issuers/changes","href":"/api-reference/endpoints/propose-approval-issuer-change"},{"title":"Approve an approver change","openapi":"openapi.bundled.yaml POST /approval-issuers/changes/{id}/approve","href":"/api-reference/endpoints/approve-approval-issuer-change"},{"title":"Reject an approver change","openapi":"openapi.bundled.yaml POST /approval-issuers/changes/{id}/reject","href":"/api-reference/endpoints/reject-approval-issuer-change"}]},{"group":"External Connectors","pages":[{"title":"List external connectors","openapi":"openapi.bundled.yaml GET /external-connectors","href":"/api-reference/endpoints/list-external-connectors"},{"title":"List external connector changes","openapi":"openapi.bundled.yaml GET /external-connectors/changes","href":"/api-reference/endpoints/list-external-connector-changes"},{"title":"Propose registering or revoking an external connector","openapi":"openapi.bundled.yaml POST /external-connectors/changes","href":"/api-reference/endpoints/propose-external-connector-change"},{"title":"Approve an external connector change","openapi":"openapi.bundled.yaml POST /external-connectors/changes/{id}/approve","href":"/api-reference/endpoints/approve-external-connector-change"},{"title":"Reject an external connector change","openapi":"openapi.bundled.yaml POST /external-connectors/changes/{id}/reject","href":"/api-reference/endpoints/reject-external-connector-change"}]},{"group":"Policy v2 (experimental)","pages":[{"title":"Record a policy version 2 decision","openapi":"openapi.bundled.yaml POST /v2/decisions","href":"/api-reference/endpoints/policy-v2-decide"},{"title":"Read a policy version 2 review as its requester sees it","openapi":"openapi.bundled.yaml GET /v2/reviews/{id}","href":"/api-reference/endpoints/policy-v2-get-review"},{"title":"Record a reviewer's decision on a review item","openapi":"openapi.bundled.yaml POST /v2/reviews/{id}/decision","href":"/api-reference/endpoints/policy-v2-decide-review"},{"title":"Replay a recorded policy version 2 decision from its evidence","openapi":"openapi.bundled.yaml GET /v2/evidence/{recordId}/replay","href":"/api-reference/endpoints/policy-v2-replay"},{"title":"Read a read-only Policy v2 console screen","openapi":"openapi.bundled.yaml GET /v2/console/{screen}","href":"/api-reference/endpoints/policy-v2-console"},{"title":"Receive an SES delivery notification (bounces and complaints)","openapi":"openapi.bundled.yaml POST /v2/notifications/ses","href":"/api-reference/endpoints/policy-v2-ses-notification"},{"title":"Receive delivery events for approval notifications","openapi":"openapi.bundled.yaml POST /v2/notifications/events","href":"/api-reference/endpoints/policy-v2-notification-events"},{"title":"Read the Policy v2 register","openapi":"openapi.bundled.yaml GET /v2/register","href":"/api-reference/endpoints/policy-v2-register-read"},{"title":"Read the register's audit log, page by page","openapi":"openapi.bundled.yaml GET /v2/register/audit","href":"/api-reference/endpoints/policy-v2-register-audit"},{"title":"Grant a register role to a caller","openapi":"openapi.bundled.yaml POST /v2/register/roles/grant","href":"/api-reference/endpoints/policy-v2-grant-role"},{"title":"Revoke a register role from a caller","openapi":"openapi.bundled.yaml POST /v2/register/roles/revoke","href":"/api-reference/endpoints/policy-v2-revoke-role"},{"title":"Propose a business-signal source","openapi":"openapi.bundled.yaml POST /v2/register/sources","href":"/api-reference/endpoints/policy-v2-propose-source"},{"title":"Approve a proposed source","openapi":"openapi.bundled.yaml POST /v2/register/sources/{name}/approve","href":"/api-reference/endpoints/policy-v2-approve-source"},{"title":"Revoke a source","openapi":"openapi.bundled.yaml POST /v2/register/sources/{name}/revoke","href":"/api-reference/endpoints/policy-v2-revoke-source"},{"title":"Propose a threshold for an action","openapi":"openapi.bundled.yaml POST /v2/register/thresholds","href":"/api-reference/endpoints/policy-v2-propose-threshold"},{"title":"Approve a proposed threshold","openapi":"openapi.bundled.yaml POST /v2/register/thresholds/{action}/{name}/approve","href":"/api-reference/endpoints/policy-v2-approve-threshold"},{"title":"Register an action (a capability with its owner and reviewers)","openapi":"openapi.bundled.yaml POST /v2/register/actions","href":"/api-reference/endpoints/policy-v2-register-action"},{"title":"Grant a reviewer on an action","openapi":"openapi.bundled.yaml POST /v2/register/actions/{capability}/reviewers","href":"/api-reference/endpoints/policy-v2-add-reviewer"},{"title":"Revoke a reviewer's grant on an action","openapi":"openapi.bundled.yaml POST /v2/register/actions/{capability}/reviewers/{reviewerId}/revoke","href":"/api-reference/endpoints/policy-v2-revoke-reviewer"},{"title":"Record that an action passed a test tier","openapi":"openapi.bundled.yaml POST /v2/register/actions/{capability}/tests","href":"/api-reference/endpoints/policy-v2-record-test"},{"title":"List what is still missing before an action can go live","openapi":"openapi.bundled.yaml GET /v2/register/actions/{capability}/go-live","href":"/api-reference/endpoints/policy-v2-go-live-gate"},{"title":"Take an action live, if its gate is met","openapi":"openapi.bundled.yaml POST /v2/register/actions/{capability}/go-live","href":"/api-reference/endpoints/policy-v2-go-live"},{"title":"Set how to reach a person about an alert","openapi":"openapi.bundled.yaml POST /v2/register/contacts","href":"/api-reference/endpoints/policy-v2-set-contact"},{"title":"Propose a new version of a policy","openapi":"openapi.bundled.yaml POST /v2/register/policies","href":"/api-reference/endpoints/policy-v2-propose-policy"},{"title":"Approve a proposed policy version","openapi":"openapi.bundled.yaml POST /v2/register/policies/{capability}/{policyVersion}/approve","href":"/api-reference/endpoints/policy-v2-approve-policy"},{"title":"Propose an approver's public key","openapi":"openapi.bundled.yaml POST /v2/register/approver-keys","href":"/api-reference/endpoints/policy-v2-propose-approver-key"},{"title":"Approve a proposed approver key","openapi":"openapi.bundled.yaml POST /v2/register/approver-keys/{approverId}/{keyId}/approve","href":"/api-reference/endpoints/policy-v2-approve-approver-key"},{"title":"Revoke an approver key","openapi":"openapi.bundled.yaml POST /v2/register/approver-keys/{approverId}/{keyId}/revoke","href":"/api-reference/endpoints/policy-v2-revoke-approver-key"}]},{"group":"Business Signal Sources","pages":[{"title":"List business signal sources","openapi":"openapi.bundled.yaml GET /business-signal-sources","href":"/api-reference/endpoints/list-business-signal-sources"},{"title":"List business signal source changes","openapi":"openapi.bundled.yaml GET /business-signal-sources/changes","href":"/api-reference/endpoints/list-business-signal-source-changes"},{"title":"Propose registering or revoking a business signal source","openapi":"openapi.bundled.yaml POST /business-signal-sources/changes","href":"/api-reference/endpoints/propose-business-signal-source-change"},{"title":"Approve a business signal source change","openapi":"openapi.bundled.yaml POST /business-signal-sources/changes/{id}/approve","href":"/api-reference/endpoints/approve-business-signal-source-change"},{"title":"Reject a business signal source change","openapi":"openapi.bundled.yaml POST /business-signal-sources/changes/{id}/reject","href":"/api-reference/endpoints/reject-business-signal-source-change"}]},{"group":"Authority Grants","pages":[{"title":"List authority grants","openapi":"openapi.bundled.yaml GET /authority-grants","href":"/api-reference/endpoints/list-authority-grants"},{"title":"List authority grant changes","openapi":"openapi.bundled.yaml GET /authority-grants/changes","href":"/api-reference/endpoints/list-authority-grant-changes"},{"title":"Propose granting or revoking an agent's authority","openapi":"openapi.bundled.yaml POST /authority-grants/changes","href":"/api-reference/endpoints/propose-authority-grant-change"},{"title":"Approve an authority grant change","openapi":"openapi.bundled.yaml POST /authority-grants/changes/{id}/approve","href":"/api-reference/endpoints/approve-authority-grant-change"},{"title":"Reject an authority grant change","openapi":"openapi.bundled.yaml POST /authority-grants/changes/{id}/reject","href":"/api-reference/endpoints/reject-authority-grant-change"}]},{"group":"Sandbox","pages":[{"title":"Get a demo approval (sandbox only)","openapi":"openapi.bundled.yaml POST /sandbox/approvals","href":"/api-reference/endpoints/create-sandbox-approval"}]},{"group":"Kill Switch","pages":[{"title":"Trip the operator kill switch","openapi":"openapi.bundled.yaml POST /kill-switch/trip","href":"/api-reference/endpoints/trip-kill-switch"},{"title":"Reset the operator kill switch","openapi":"openapi.bundled.yaml POST /kill-switch/reset","href":"/api-reference/endpoints/reset-kill-switch"},{"title":"Read the kill switch state","openapi":"openapi.bundled.yaml GET /kill-switch/status","href":"/api-reference/endpoints/get-kill-switch-status"},{"title":"Record a kill switch probe result","openapi":"openapi.bundled.yaml POST /kill-switch/probes","href":"/api-reference/endpoints/record-kill-switch-probe"}]},{"group":"Refusal Records","pages":[{"title":"Verify a Refusal Record's signature","openapi":"openapi.bundled.yaml POST /refusal/verify","href":"/api-reference/endpoints/verify-refusal-record"},{"title":"Get a Refusal Record by transaction ID","openapi":"openapi.bundled.yaml GET /refusal/{businessTransactionId}","href":"/api-reference/endpoints/get-refusal-record"}]},{"group":"Execution Intents","pages":[{"title":"Verify an Execution Intent's signature","openapi":"openapi.bundled.yaml POST /execution-intents/verify","href":"/api-reference/endpoints/verify-execution-intent"},{"title":"List Execution Intents that never reached a signed Trust Record","openapi":"openapi.bundled.yaml GET /execution-intents/unfinalized","href":"/api-reference/endpoints/list-unfinalized-execution-intents"},{"title":"Get an Execution Intent and its status","openapi":"openapi.bundled.yaml GET /execution-intents/{businessTransactionId}","href":"/api-reference/endpoints/get-execution-intent"},{"title":"Rebuild the signed Trust Record for a released action","openapi":"openapi.bundled.yaml POST /execution-intents/{businessTransactionId}/finalize","href":"/api-reference/endpoints/finalize-execution-intent"},{"title":"Close an intent you reconciled by hand","openapi":"openapi.bundled.yaml POST /execution-intents/{businessTransactionId}/resolve","href":"/api-reference/endpoints/resolve-execution-intent"}]},{"group":"Audit","pages":[{"title":"Verify a signed caller-authentication audit event","openapi":"openapi.bundled.yaml POST /audit/verify","href":"/api-reference/endpoints/verify-audit-event"}]},{"group":"System","pages":[{"title":"Root","openapi":"openapi.bundled.yaml GET /","href":"/api-reference/endpoints/get-root"},{"title":"Health check","openapi":"openapi.bundled.yaml GET /health","href":"/api-reference/endpoints/get-health"},{"title":"Readiness check","openapi":"openapi.bundled.yaml GET /ready","href":"/api-reference/endpoints/get-ready"},{"title":"Get the OpenAPI spec","openapi":"openapi.bundled.yaml GET /openapi.yaml","href":"/api-reference/endpoints/get-open-api-spec"},{"title":"Get the OpenAPI spec, as JSON","openapi":"openapi.bundled.yaml GET /openapi.json","href":"/api-reference/endpoints/get-open-api-spec-json"},{"title":"Machine-readable SDK and discovery manifest","openapi":"openapi.bundled.yaml GET /api-manifest.json","href":"/api-reference/endpoints/get-api-manifest"},{"title":"Service version","openapi":"openapi.bundled.yaml GET /version","href":"/api-reference/endpoints/get-version"},{"title":"Fetch a public signing key for independent, offline verification","openapi":"openapi.bundled.yaml GET /keys/{keyId}","href":"/api-reference/endpoints/get-key"},{"title":"List every public signing key this deployment can currently produce","openapi":"openapi.bundled.yaml GET /.well-known/jwks.json","href":"/api-reference/endpoints/get-jwks"},{"title":"Get the authenticated caller's identity and resolved scope","openapi":"openapi.bundled.yaml GET /callers/me","href":"/api-reference/endpoints/get-caller-me"}]},{"group":"Handbook","pages":[{"title":"Download the Parmana Handbook (PDF)","openapi":"openapi.bundled.yaml GET /parmana-handbook.pdf","href":"/api-reference/endpoints/get-handbook-pdf"},{"title":"Capture an email address, then redirect straight to the handbook PDF","openapi":"openapi.bundled.yaml GET /handbook/download-leads","href":"/api-reference/endpoints/get-handbook-download-lead"},{"title":"Capture an email address before unlocking the handbook PDF download","openapi":"openapi.bundled.yaml POST /handbook/download-leads","href":"/api-reference/endpoints/create-handbook-download-lead"}]}]},{"tab":"Deploy and operate","pages":[{"title":"Deploy and operate","href":"/self-hosted/overview"}]},{"tab":"Reference","pages":[{"title":"Reference","href":"/reference/shared"}]},{"tab":"Build book","pages":[{"title":"Build book","href":"/build-book/overview"}]},{"tab":"Handbook","pages":[{"title":"Handbook","href":"/handbook/overview"}]}]},"basePath":"","title":"Declare a Business Transaction - Parmana","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["10e4515597","c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["BannerMarkdown-BOAJk9BH.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js"]}