TransactionResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woolworths-group/main/json-schema/woolworths-group-transaction-response-schema.json",
  "title": "TransactionResponse",
  "x-generated": "2026-10-22",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/woolworths-group-wpay-payment-openapi.yml#/components/schemas/TransactionResponse",
  "type": "object",
  "properties": {
    "outcome": {
      "$ref": "#/$defs/ResponseOutcome"
    },
    "acquirerId": {
      "type": "string",
      "description": "echoed from the request"
    },
    "auditNumber": {
      "type": "string",
      "description": "echoed from the request"
    },
    "terminalId": {
      "type": "string",
      "description": "Echoed from the request"
    },
    "transmissionDateTime": {
      "type": "string",
      "description": "echoed from the request",
      "format": "date-time"
    },
    "referenceNumber": {
      "type": "string",
      "description": "echoed from the request"
    },
    "settlementDate": {
      "type": "string",
      "description": "Contains settlement date of the corresponding request."
    },
    "keySerialNumber": {
      "type": "string",
      "description": "AES DUKPT Key Serial Number. This information isn't needed for advice messages like Captures and Reversals. If included, it will be removed before reaching the switch."
    },
    "cardholderAuthenticationResult": {
      "type": "string",
      "description": "This element returns the Cardholder Authentication verification Result(CAR) in PREAUTH and CAPTURE and REFUND request resonses. This is also called \"CAVV Results Code Values\" in visa manual. This element is in \"CARx' format where 'x' can be any of the following:\n\n  \n| Values        | Description            | \n| ---------------- | -------------------------------------------------|\n|    'car' element not in response     |  Field not sent            | \n| 0         | CAVV not validated due to data error       | \n| 1         | CAVV failed validation               | \n| 2         | CAVV passed validation |\n| 3         | CAVV validation could not be performed (Authentication attempted, but not completed)|\n| 4         | CAVV validation could not be performed (System error or authentication failure)     |\n| 5         |CAVV not validated (issuer is not a CAVV service participant)                        |\n| 6         | CAVV not validated (issuer is not set to participate any CAVV service)              |\n| 7         | CAVV failed validation – attempt (U.S. – issued cards only)                         |\n| 8         | CAVV passed validation – attempt (U.S. – issued cards only)|\n| 9         | CAVV failed validation – attempt (U.S. – issued cards only)|\n| A         | CAVV passed validation – attempt (U.S. – issued cards only)     |\n| B         | CAVV passed validation – information only                   |\n| C         | CAVV was not validated – attempt     |\n| D         | CAVV passed validation – authentication |"
    },
    "paymentTokenData": {
      "type": "string",
      "description": "The payment token data are used to transmit information that is specific to the use of a Payment token in a financial or non-financial transaction. It is formed as a serie of TLV (Tag, Length, value) individual data objects where: T = 3-digit numeric encoded as 3 ASCII digits L = 3-digit length (represented as number of bytes) of following variable value (exclusive of the tag ID and length indicators) encoded as 3 ASCII digits V = variable value.  Tags may be present in any order."
    },
    "card": {
      "$ref": "#/$defs/ResponseCardDetails"
    },
    "capture": {
      "$ref": "#/$defs/ResponseCaptureTransaction"
    },
    "merchant": {
      "$ref": "#/$defs/ResponseMerchantDetails"
    },
    "schemeExtendedData": {
      "$ref": "#/$defs/SchemeExtendedResponseData"
    },
    "amount": {
      "$ref": "#/$defs/ResponseAmount"
    }
  },
  "$defs": {
    "ErrorDetails": {
      "type": "object",
      "properties": {
        "code": {
          "type": "string",
          "description": "This element indicates the diagonostic code for response.",
          "enum": [
            "002",
            "003",
            "004",
            "005",
            "006",
            "007",
            "008",
            "009",
            "010",
            "011",
            "012",
            "013",
            "014",
            "015",
            "016",
            "017",
            "018",
            "019",
            "020",
            "021",
            "022",
            "023",
            "024",
            "025",
            "026",
            "027",
            "028",
            "029",
            "030",
            "031",
            "032",
            "033",
            "034",
            "035",
            "036",
            "040",
            "041",
            "045",
            "049",
            "050",
            "051",
            "052",
            "053",
            "054",
            "057",
            "064",
            "090",
            "100",
            "110",
            "128",
            "201",
            "236",
            "404"
          ],
          "default": false
        },
        "message": {
          "type": "string",
          "description": "This element indicates the diagonostic code message for the response",
          "default": false
        }
      }
    },
    "ResponseAmount": {
      "type": "object",
      "properties": {
        "totalAmount": {
          "type": "number",
          "description": "Total amount echoed from the request."
        },
        "currency": {
          "type": "string",
          "description": "Three Characters long currency code."
        }
      }
    },
    "ResponseCaptureTransaction": {
      "type": "object",
      "properties": {
        "authorisationResponseId": {
          "type": "string",
          "description": "Issuer's response for any PREAUTH request if its approved. According to payment standards, this field may contain alphanumeric characters including leading or trailing spaces, which should be provided as such for subsequent operations such as a Capture."
        },
        "schemeTraceId": {
          "type": "string",
          "description": "schemeTraceId is a unique identifier provided by the schemes to authorise a request. Visa refer to this as a transaction identifier, while Mastercard refer to it as a trace identifier.  ANZ will call it a transaction ID. We will return this in the schemeTraceid element to the merchant in the response. This element will be provided in subsequent  CAPTURE and CANCEL requests to link the transactions to the previous or original transaction. It will be in \"yyxxxxxxxxxxxxx\" where 'yy' can be VI for Visa, MC for MasterCard and 'x' is the trace id number."
        }
      }
    },
    "ResponseCardDetails": {
      "type": "object",
      "properties": {
        "primaryAccountNumber": {
          "type": "string",
          "description": "Echoed from the request. It will be returned in PREAUTH and CAPTURE requests only. "
        },
        "emvData": {
          "type": "string",
          "description": "This element is retured in the PREAUTH and CAPTURE requests only if issuer returns it in the response."
        },
        "ccvStatus": {
          "type": "string",
          "description": ""
        },
        "accountType": {
          "type": "string",
          "description": "Echoed from the request."
        }
      }
    },
    "ResponseMerchantDetails": {
      "type": "object",
      "properties": {
        "merchantId": {
          "type": "string",
          "description": "echoed from the request"
        }
      }
    },
    "ResponseOutcome": {
      "type": "object",
      "properties": {
        "statusCode": {
          "type": "string",
          "description": "Response Code. \n\n| statusCode | message | result |\n|---------------- |-------------------------------------------------|-------------------------- |\n| 00 | Approved or completed | Successful\n| 01 | Refer to card issuer | Not Successful\n| 02 | Refer to card issuer's special conditions | Not Successful\n| 03 | Invalid Merchant | Not Successful\n| 04 | Pick-up Card | Not Successful\n| 05 | Do not honour | Not Successful\n| 06 | Error | Not Successful\n| 08 | Honour with Identification | Successful\n| 10 | Approved for Partial Amount | Successful - Check the response for approved amount\n| 11 | Approved VIP | Successful\n| 12 | Invalid transaction | Not Successful\n| 13 | Invalid amount | Not Successful\n| 14 | Invalid card number (no such number) | Not Successful\n| 16 | Approved - Update track 3 | Successful\n| 19 | Re-enter transaction | Not Successful\n| 30 | Format error in the request message. | Not Successful\n| 31 | Bank not supported by switch | Not Successful\n| 33 | Expired card | Not Successful\n| 34 | Suspected fraud | Not Successful\n| 35 | Card acceptor contact issuer | Not Successful\n| 36 | Restricted card | Not Successful\n| 38 | Allowable PIN tries exceeded | Not Successful\n| 39 | No credit access | Not Successful\n| 40 | Request function not supported | Not Successful\n| 41 | Lost card | Not Successful\n| 42 | No universal account | Not Successful\n| 43 | Stolen card, pick-up | Not Successful\n| 44 | No investment account | Not Successful\n| 45 | Reserved for ISO use | Not Successful\n| 46 | Reserved for ISO use | Not Successful\n| 47 | Reserved for ISO use | Not Successful\n| 48 | Reserved for ISO use | Not Successful\n| 49 | Reserved for ISO use | Not Successful\n| 50 | Reserved for ISO use | Not Successful\n| 51 | Not sufficient funds | Not Successful\n| 52 | No cheque account | Not Successful\n| 53 | No savings account | Not Successful\n| 54 | Expired card | Not Successful\n| 55 | Incorrect Personal Identification Number | Not Successful\n| 56 | No card record | Not Successful\n| 57 | Transaction not permitted to cardholder | Not Successful\n| 58 | Transaction not permitted to terminal | Not Successful\n| 59 | Suspected fraud | Not Successful\n| 60 | Card acceptor contact acquirer | Not Successful\n| 61 | Exceeds withdrawal amount limits | Not Successful\n| 62 | Restricted card | Not Successful\n| 63 | Security violation | Not Successful\n| 64 | Original amount incorrect | Not Successful\n| 65 | Exceeds withdrawal frequency limit | Not Successful\n| 69 | Reserved for ISO use | Not Successful\n| 70 | Reserved for ISO use | Not Successful\n| 71 | Reserved for ISO use | Not Successful\n| 72 | Reserved for ISO use | Not Successful\n| 73 | Reserved for ISO use | Not Successful\n| 74 | Reserved for ISO use | Not Successful\n| 75 | Allowable number of PIN tries exceeded | Not Successful\n| 77 | Reserved for private use | Not Successful\n| 78 | Reserved for private use | Not Successful\n| 79 | Reserved for private use | Not Successful\n| 80 | Reserved for private use | Not Successful\n| 81 | Reserved for private use | Not Successful\n| 82 | Reserved for private use | Not Successful\n| 83 | Reserved for private use | Not Successful\n| 84 | Reserved for private use | Not Successful\n| 85 | Reserved for private use | Not Successful\n| 86 | Reserved for private use | Not Successful\n| 87 | Reserved for private use | Not Successful\n| 88 | Reserved for private use | Not Successful\n| 89 | Reserved for private use | Not Successful\n| 91 | Issuer or switch is Inoperative | Not Successful\n| 92 | Financial institution or intermediate network facility not be found for routing | Not Successful\n| 94 | Duplicate transmission | Not Successful\n| 95 | Reconcile Error | Not Successful\n| 96 | System malfunction | Not Successful\n| 99 | PAN or token lookup error | Not Successful",
          "enum": [
            "00",
            "01",
            "02",
            "03",
            "04",
            "05",
            "06",
            "08",
            "10",
            "11",
            "12",
            "13",
            "14",
            "16",
            "19",
            "30",
            "31",
            "33",
            "34",
            "35",
            "36",
            "38",
            "39",
            "40",
            "41",
            "42",
            "43",
            "44",
            "45",
            "46",
            "47",
            "48",
            "49",
            "50",
            "51",
            "52",
            "53",
            "54",
            "55",
            "56",
            "57",
            "58",
            "59",
            "60",
            "61",
            "62",
            "63",
            "64",
            "65",
            "69",
            "70",
            "71",
            "72",
            "73",
            "74",
            "75",
            "77",
            "78",
            "79",
            "80",
            "81",
            "82",
            "83",
            "84",
            "85",
            "86",
            "87",
            "88",
            "89",
            "91",
            "92",
            "94",
            "95",
            "96",
            "99"
          ]
        },
        "message": {
          "type": "string",
          "description": "Response message which is mapped to the response code. Please refer to the table above for response codes and relevant messages."
        },
        "errorDetails": {
          "$ref": "#/$defs/ErrorDetails"
        }
      }
    },
    "SchemeExtendedResponseData": {
      "description": "This element is populated with additional scheme related meta data if available.",
      "type": "object",
      "properties": {
        "mastercardTransactionLinkId": {
          "type": "string",
          "description": "Mastercard Transaction Link Identifier (TLID); a 22-character long alphanumeric identifier used by Mastercard to link different events in the lifecycle of a transaction. If you received a TLID in an authorisation or sale response, provide it for subsequent operations on the same transaction such as a completion or void.",
          "maxLength": 22,
          "minLength": 22
        }
      }
    }
  }
}