---
title: "TransactionAttributesResponse"
url: "https://developers.zinnia.com/apis/policy-transactions-1-0-2/versions/d0006570-ab9d-464e-814f-d120ba425e84/schemas/TransactionAttributesResponse"
---

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

# TransactionAttributesResponse

Response for GET /policy/v1/transactions/{planCode}/{policyNumber}/transaction-attributes/{transactionType}. Always returns HTTP 200. Check `found` to determine whether configuration exists. Attributes are merged from `ref-transaction-attributes` (plan-specific) and `ref-transaction-attributes-default` (client-level defaults); specific takes precedence on collision.

## 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
components:
  schemas:
    TransactionAttributeRecord:
      type: object
      description: >
        A single resolved attribute entry. Always contains only the final
        resolved value — override configuration is never included in the
        response.
      required:
        - attributeName
        - attributeType
        - attributeValue
      properties:
        attributeName:
          type: string
          description: Attribute identifier.
          example: sendPaymentToBrokrageAccount
        attributeType:
          type: string
          enum:
            - STRING
            - BOOLEAN
            - NUMBER
            - LIST
          description: Data type of the attribute value.
          example: BOOLEAN
        itemType:
          type: string
          nullable: true
          description: Required when attributeType is LIST (e.g. "STRING"); null for all
            other types.
          example: STRING
        attributeValue:
          description: >
            The resolved value. Type corresponds to attributeType — Boolean,
            String, Number, or array of itemType for LIST. For derived
            attributes this reflects the matched override value, or the
            configured default when no override matched.
          example: true
    TransactionAttributesResponse:
      type: object
      description: |
        Response for GET /policy/v1/transactions/{planCode}/{policyNumber}/transaction-attributes/{transactionType}. Always returns HTTP 200. Check `found` to determine whether configuration exists. Attributes are merged from `ref-transaction-attributes` (plan-specific) and `ref-transaction-attributes-default` (client-level defaults); specific takes precedence on collision.
      required:
        - found
        - planCode
        - policyNumber
        - transactionType
        - attributes
      properties:
        found:
          type: boolean
          description: true when at least one collection returned a record and attributes
            were resolved; false otherwise.
          example: true
        message:
          type: string
          nullable: true
          description: Human-readable explanation when found is false. Absent when found
            is true.
          example: No attribute configuration found for transactionType=Nonforfeiture,
            clientCode=GILI, planCode=GCFIA901
        clientCode:
          type: string
          nullable: true
          description: Carrier code derived from the policy. Null when the policy could
            not be fetched.
          example: GILI
        planCode:
          type: string
          description: Plan code from the request path.
          example: GCFIA901
        policyNumber:
          type: string
          description: Policy number from the request path.
          example: "9013055733"
        transactionType:
          type: string
          description: Transaction type from the request path.
          example: OneTimeWithdrawal
        attributes:
          type: array
          description: >
            Merged and resolved attributes. Default attributes not overridden by
            the specific plan record are included. Empty array when found is
            false.
          items:
            $ref: "#/components/schemas/TransactionAttributeRecord"
```