CnpVoidsResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woolworths-group/main/json-schema/woolworths-group-cnp-voids-response-schema.json",
  "title": "CnpVoidsResponse",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/woolworths-group-wpay-cards-connect-openapi.yml#/components/schemas/CnpVoidsResponse",
  "required": [
    "browserViewLink",
    "permittedActionHints",
    "reconciliationId",
    "transactionId",
    "voids"
  ],
  "type": "object",
  "properties": {
    "transactionId": {
      "type": "string",
      "description": "The unique identifier of the transaction passed during the authorization request"
    },
    "reconciliationId": {
      "type": "string",
      "description": "Reconciliation id passed during the authorization request"
    },
    "permittedActionHints": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/PermittedTransactionOperationHint"
      },
      "description": "Provides hints of permitted actions based on the state of the transaction"
    },
    "browserViewLink": {
      "type": [
        "string",
        "null"
      ],
      "description": "A direct link for viewing the transaction in the Cards Connect Portal for end-users."
    },
    "voids": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/$defs/VoidResponse"
      }
    }
  },
  "additionalProperties": false,
  "$defs": {
    "PermittedTransactionOperationHint": {
      "enum": [
        "Capture",
        "Void",
        "Refund"
      ],
      "type": "string",
      "description": "Hints for transaction operation permitted for the given transaction state "
    },
    "SchemeExtendedResponseData": {
      "type": "object",
      "properties": {
        "mastercardTransactionLinkId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Mastercard Transaction Link Identifier (TLID) used by Mastercard to link different events in the lifecycle of a transaction."
        }
      },
      "additionalProperties": false
    },
    "TransactionOutcome": {
      "enum": [
        "Accepted",
        "InProgress",
        "InProgressDelayed",
        "Succeeded",
        "Declined",
        "BusyFailing",
        "BusyFailingDelayed",
        "Failed",
        "Ruined"
      ],
      "type": "string"
    },
    "VoidResponse": {
      "required": [
        "id"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Unique identifier of the void operation, as passed during the void request"
        },
        "amount": {
          "type": "integer",
          "description": "The amount voided by the void request",
          "format": "int32"
        },
        "outcome": {
          "$ref": "#/$defs/TransactionOutcome"
        },
        "responseCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "Null for void operation"
        },
        "responseDescription": {
          "type": [
            "string",
            "null"
          ],
          "description": "Null for void operation"
        },
        "createdAt": {
          "type": "string",
          "description": "Date and time when this void was created in our system",
          "format": "date-time"
        },
        "schemeExtendedResponseData": {
          "$ref": "#/$defs/SchemeExtendedResponseData"
        }
      },
      "additionalProperties": false
    }
  }
}