Operation MetadataOperation metadata

Operation metadata

Flat metadata (category, payment purpose, tags, references). Not to be confused with configurable categories, which live in /categories and are versioned

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/metadata" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "id": "cmr3f41z20001psp7phmyapw3",
  "vaultId": "example_string",
  "operationType": "deposit",
  "operationId": "example_string",
  "paymentPurpose": "example_string",
  "category": "example_string",
  "tagsJson": [
    "example_string"
  ],
  "description": "example_string",
  "externalReference": "example_string",
  "clientReference": "example_string",
  "dealId": "example_string",
  "invoiceId": "example_string",
  "orderId": "example_string",
  "settlementId": "example_string",
  "obligationId": "example_string",
  "version": 42,
  "createdById": "example_string",
  "updatedById": "example_string",
  "createdAt": "2026-07-02T11:25:15.134000Z",
  "updatedAt": "2026-07-02T11:25:15.134000Z"
}
GET
/api/v1/vaults/{code}/operations/{operationType}/{operationId}/metadata
GET
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Session token. Mobile/services. The web uses a cookie.

Session token. Mobile/services. The web uses a cookie.
API Key (cookie: session_token)
session_tokenstring
Required

API key (sent in cookie)

path
codestring
Required

Unique Vault code (slug)

path
operationTypestring
Required
Options: deposit, transfer
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Session token. Mobile/services. The web uses a cookie.

path
parameterstring
Required

API Key for authentication. Provide your API key in the cookie.

Path Parameters

codestring
Required

Unique Vault code (slug)

Example:
demo_vault
operationTypestring
Required
Allowed values:deposittransfer

Responses

idstring
Required

cuid

vaultIdstring
Required
operationTypestring
Required
Allowed values:deposittransfer
operationIdstring
Required
paymentPurposestring
Required
categorystring
Required

Category code (built-in: invoice_payment, advance, refund, asset_purchase, asset_sale, debt_repayment, deposit, withdrawal, internal_transfer, adjustment, unknown)

tagsJsonstring
Required
descriptionstring
Required
externalReferencestring
Required
clientReferencestring
Required
dealIdstring
Required
invoiceIdstring
Required
orderIdstring
Required
settlementIdstring
Required
obligationIdstring
Required
versioninteger
Required
createdByIdstring
Required
updatedByIdstring
Required
createdAtstring
Required
updatedAtstring
Required