Operation MetadataOperation relations

Operation relations

An operation's relations to others: refund, reversal, correction, replacement. Direction matters: an operation can be both the source and the target of a relation

curl -X GET "https://policy-engine-rest.ezig.workers.dev/api/v1/vaults/demo_vault/operations/deposit/example_string/relations" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
[
  {
    "id": "cmr3f41z20001psp7phmyapw3",
    "vaultId": "example_string",
    "sourceOperationType": "deposit",
    "sourceOperationId": "example_string",
    "targetOperationType": "deposit",
    "targetOperationId": "example_string",
    "relationType": "refund",
    "relatedAmountRaw": "example_string",
    "tokenId": "example_string",
    "comment": "example_string",
    "createdById": "example_string",
    "createdAt": "2026-07-02T11:25:15.134000Z"
  }
]
GET
/api/v1/vaults/{code}/operations/{operationType}/{operationId}/relations
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
sourceOperationTypestring
Required
Allowed values:deposittransfer
sourceOperationIdstring
Required
targetOperationTypestring
Required
Allowed values:deposittransfer
targetOperationIdstring
Required
relationTypestring
Required
Allowed values:refundreversalcorrectionreplacement
relatedAmountRawstring
Required

For a partial refund: raw smallest units

tokenIdstring
Required
commentstring
Required
createdByIdstring
Required
createdAtstring
Required