---
title: "Secure API to get TransactionData by transactionId"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/operations/getTransactionData"
---

> Full API specification: https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84.md

# Secure API to get TransactionData by transactionId

`GET` `/bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}`

Operation ID: `getTransactionData`

## Path parameters

- `transactionId` (string, required)

## Responses

- `200` - Transaction Model success
- `401` - Unauthorized - Missing or invalid JWT token
- `403` - Forbidden - Insufficient permissions or invalid scope
- `404` - Not Found - Transaction not found or correlationId unknown
- `500` - Internal Server Error - Unexpected system failure

## OpenAPI definition

```yaml
openapi: 3.1.0
info:
  title: Zinnia Policy Transactions API.
  version: 1.0.8
servers:
  - url: https://dev.api.zinnia.io
    description: DEV Environment
  - url: https://qa.api.zinnia.io
    description: QA Environment
paths:
  /bpm/v1/policies/withdrawals/transactionstore/entities/{transactionId}:
    get:
      x-internal: true
      tags:
        - TransactionData
      summary: Secure API to get TransactionData by transactionId
      operationId: getTransactionData
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
      responses:
        "200":
          description: Transaction Model success
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TransactionModelResponse"
        "401":
          description: Unauthorized - Missing or invalid JWT token
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                status: 401
                message: "Authentication failed: missing or invalid bearer token."
        "403":
          description: Forbidden - Insufficient permissions or invalid scope
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                status: 403
                message: "Access denied: client does not have permission to get contract details
                  via this API."
        "404":
          description: Not Found - Transaction not found or correlationId unknown
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                status: 404
                message: "Transaction not found for correlationId:
                  468cd184-fb43-4a20-aa8c-23df99c0a353"
        "500":
          description: Internal Server Error - Unexpected system failure
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ErrorResponse"
              example:
                status: 500
                message: An unexpected error occurred while processing the callback request.
      security:
        - Auth0: []
security:
  - Auth0: []
components:
  schemas:
    TransactionModelResponse:
      type: object
      description: Model for a transaction with detailed information.
      properties:
        recordId:
          type: string
          description: Unique identifier for the transaction record.
        correlationId:
          type: string
          description: Correlation ID associated with the transaction.
        transactionType:
          type: string
          description: Type of transaction.
        carrier:
          type: string
          description: Carrier associated with the transaction.
        source:
          type: string
          description: Source of the transaction.
        entityType:
          type: string
          description: Type of the entity involved.
        entityId:
          type: string
          description: Unique identifier for the entity.
        entity:
          type: object
          description: Actual entity information as JSON Object.
        expireTs:
          type: string
          format: date-time
          description: Expiration timestamp for the transaction.
        createdTs:
          type: string
          format: date-time
          description: Timestamp when the transaction was created.
        updatedTs:
          type: string
          format: date-time
          description: Timestamp when the transaction was last updated.
        createdBy:
          type: string
          description: User or system that created the transaction.
        updatedBy:
          type: string
          description: User or system that last updated the transaction.
        identifiers:
          type: array
          description: List of identifiers related to the transaction.
          items:
            $ref: "#/components/schemas/Identifiers"
    ErrorResponse:
      type: object
      properties:
        status:
          type: integer
          example: 404
        message:
          type: string
          example: "Invalid or missing request field: correlationId"
    Identifiers:
      type: object
      description: Identifier model with key-value pair.
      properties:
        identifier:
          type: string
          description: Identifier key.
        value:
          type: string
          description: Identifier value.
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.qa.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          run_on_preflight: true
          scopes_claim:
            - https://qa.api.zinnia.io/permissions
          audience_claim:
            - aud
          audience_required:
            - https://qa.api.zinnia.io
          client_id:
            - client_id
          auth_methods:
            - bearer
        enabled: true
        protocols:
          - grpc
          - grpcs
          - http
          - https
```