Balance_getTransactionHistoryApi_Response_200

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/brevo/main/json-schema/brevo-balance-get-transaction-history-api-response-200-schema.json",
  "title": "Balance_getTransactionHistoryApi_Response_200",
  "description": "Response containing transaction history details for a specific balance and contact.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/brevo-balance-api-openapi.yml#/components/schemas/Balance_getTransactionHistoryApi_Response_200",
  "type": "object",
  "properties": {
    "balanceDefinitionId": {
      "type": "string",
      "description": "Unique identifier of the associated balance definition."
    },
    "contactId": {
      "type": "integer",
      "description": "Unique identifier of the contact related to the transactions."
    },
    "count": {
      "type": "integer",
      "description": "Total number of transactions in the history."
    },
    "loyaltyProgramId": {
      "type": "string",
      "description": "Unique identifier of the associated loyalty program."
    },
    "transactionHistory": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItems"
      },
      "description": "List of past transactions associated with the balance."
    }
  },
  "$defs": {
    "LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItems": {
      "type": "object",
      "properties": {
        "amount": {
          "type": "string",
          "title": "float",
          "description": "The transaction amount."
        },
        "transactionType": {
          "$ref": "#/$defs/LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItemsTransactionType",
          "description": "The type of the transaction."
        },
        "balanceExpirationDate": {
          "type": "string",
          "description": "Expiration date of the balance associated with this transaction."
        },
        "cancelledAt": {
          "type": "string",
          "description": "Timestamp when the transaction was canceled, if applicable."
        },
        "completedAt": {
          "type": "string",
          "description": "Timestamp when the transaction was successfully completed."
        },
        "createdAt": {
          "type": "string",
          "description": "Timestamp when the transaction was initiated."
        },
        "id": {
          "type": "string",
          "description": "Unique identifier of the transaction."
        },
        "meta": {
          "type": "object",
          "additionalProperties": {
            "description": "Any type"
          },
          "description": "Optional metadata associated with the transaction."
        },
        "rejectReason": {
          "type": "string",
          "description": "Reason for rejection, if the transaction was declined."
        },
        "rejectedAt": {
          "type": "string",
          "description": "Timestamp when the transaction was rejected."
        },
        "status": {
          "type": "string",
          "description": "Current status of the transaction (e.g., pending, completed, rejected)."
        }
      },
      "description": "Represents a record of a past transaction, including status and key timestamps.",
      "title": "LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItems"
    },
    "LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItemsTransactionType": {
      "type": "string",
      "enum": [
        "credit",
        "debit"
      ],
      "description": "The type of the transaction.",
      "title": "LoyaltyBalanceProgramsPidTransactionHistoryGetResponsesContentApplicationJsonSchemaTransactionHistoryItemsTransactionType"
    }
  }
}