CnpAuthorizationRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woolworths-group/main/json-schema/woolworths-group-cnp-authorization-request-schema.json",
  "title": "CnpAuthorizationRequest",
  "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/CnpAuthorizationRequest",
  "required": [
    "amount",
    "cardDetailsEncrypted",
    "currency",
    "reconciliationId"
  ],
  "type": "object",
  "properties": {
    "reconciliationId": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string",
      "description": "An identifier that may be used to link authorization with subsequent operations for reconciliation purpose."
    },
    "paymentSource": {
      "$ref": "#/$defs/PaymentSource"
    },
    "cardDetails": {
      "oneOf": [
        {
          "$ref": "#/$defs/PanCardInformationDetails"
        },
        {
          "$ref": "#/$defs/NetworkTokenCardDetails"
        },
        {
          "$ref": "#/$defs/ApplePayWalletCardDetails"
        },
        {
          "$ref": "#/$defs/GooglePayWalletCardDetails"
        }
      ],
      "description": "Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API. ",
      "nullable": true
    },
    "cardDetailsEncrypted": {
      "minLength": 1,
      "type": "string",
      "description": "This field contains the fields from CardDetails encrypted using the JWE technique specified in the encryption guide."
    },
    "webhookUrl": {
      "type": [
        "string",
        "null"
      ],
      "description": "Webhook URL that will be called by Cards Connect to deliver notifications about the status of the transaction."
    },
    "threeDSecureData": {
      "$ref": "#/$defs/ThreeDSecureData"
    },
    "threeDSecureDataEncrypted": {
      "type": [
        "string",
        "null"
      ],
      "description": "This field contains the fields from ThreeDSecureData encrypted using the JWE technique specified in the encryption guide."
    },
    "orderId": {
      "maxLength": 64,
      "minLength": 0,
      "type": [
        "string",
        "null"
      ],
      "description": "Order id generated by the merchant’s system."
    },
    "amount": {
      "maximum": 99999999,
      "minimum": 1,
      "type": "integer",
      "description": "Amount of the transaction in cents. 1499 is $14.99.",
      "format": "int32"
    },
    "currency": {
      "maxLength": 3,
      "minLength": 3,
      "type": "string",
      "description": "ISO 4217 currency of the transaction."
    },
    "statementDescriptor": {
      "$ref": "#/$defs/StatementDescriptor"
    },
    "externalBuyerId": {
      "type": [
        "string",
        "null"
      ],
      "description": "Cardholder’s id known to the external system, such as merchant’s CRM application."
    },
    "billingDetails": {
      "$ref": "#/$defs/BillingDetails"
    },
    "billingDetailsEncrypted": {
      "type": [
        "string",
        "null"
      ],
      "description": "This field contains the fields from BillingDetails encrypted using the JWE technique specified in the encryption guide."
    },
    "previousSchemeTraceId": {
      "type": [
        "string",
        "null"
      ],
      "description": "A scheme's transaction identifier to use in connecting a merchant initiated transaction to the initial customer initiated transaction."
    },
    "isSubsequentTransaction": {
      "type": "boolean",
      "description": "Indicates whether the transaction represents a subsequent payment coming from a recurring payment setup."
    },
    "merchantInitiated": {
      "type": "boolean",
      "description": "Indicates whether the transaction was initiated by the merchant (True) or customer (False or omitted)."
    },
    "schemeExtendedRequestData": {
      "$ref": "#/$defs/SchemeExtendedRequestData"
    }
  },
  "additionalProperties": false,
  "$defs": {
    "ApplePayWalletCardDetails": {
      "required": [
        "cardType"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/PaymentInstrumentDetails"
        },
        {
          "required": [
            "tokenCryptogram"
          ],
          "type": "object",
          "properties": {
            "tokenCryptogram": {
              "maxLength": 64,
              "minLength": 0,
              "type": "string",
              "description": "A one-time cryptographic value used to ensure that the token is authorized for the transaction.This value must be standard Base64-encoded string up to 64 characters long.",
              "format": "byte"
            }
          },
          "additionalProperties": false
        }
      ],
      "properties": {
        "cardType": {
          "title": "ApplePay",
          "enum": [
            "ApplePay"
          ],
          "type": "string",
          "description": "Always `ApplePay`",
          "default": "ApplePay"
        }
      },
      "description": "Apple Pay mobile wallet token details for this transaction."
    },
    "BillingDetails": {
      "type": "object",
      "properties": {
        "firstName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s first name. If the cardholder has a middle name, it should be included here."
        },
        "lastName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s last name."
        },
        "emailAddress": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s e-mail address.",
          "format": "email"
        },
        "phoneNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s phone number in E.164 format."
        },
        "addressLine1": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s billing address line 1."
        },
        "addressLine2": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder’s billing address line 2, if necessary."
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City of the billing address."
        },
        "suburb": {
          "type": [
            "string",
            "null"
          ],
          "description": "Suburb of the billing address."
        },
        "state": {
          "type": [
            "string",
            "null"
          ],
          "description": "State of the billing address."
        },
        "postCode": {
          "type": [
            "string",
            "null"
          ],
          "description": "Post code of the billing address."
        },
        "country": {
          "type": [
            "string",
            "null"
          ],
          "description": "Country of the billing address."
        }
      },
      "additionalProperties": false,
      "description": "This object contains cardholder’s billing details that might be used by the scheme to verify the transaction. Note that the encrypted contents of this field should be passed in the billingDetailsEncrypted field. An error result if raw card data is included in the request."
    },
    "GooglePayWalletCardDetails": {
      "required": [
        "cardType"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/PaymentInstrumentDetails"
        },
        {
          "required": [
            "tokenCryptogram"
          ],
          "type": "object",
          "properties": {
            "tokenCryptogram": {
              "maxLength": 64,
              "minLength": 0,
              "type": "string",
              "description": "A one-time cryptographic value used to ensure that the token is authorized for the transaction.This value must be standard Base64-encoded string up to 64 characters long.",
              "format": "byte"
            }
          },
          "additionalProperties": false
        }
      ],
      "properties": {
        "cardType": {
          "title": "GooglePay",
          "enum": [
            "GooglePay"
          ],
          "type": "string",
          "description": "Always `GooglePay`",
          "default": "GooglePay"
        }
      },
      "description": "Google Pay mobile wallet token details for this transaction."
    },
    "NetworkTokenCardDetails": {
      "required": [
        "cardType"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/PaymentInstrumentDetails"
        },
        {
          "type": "object",
          "properties": {
            "cvv": {
              "type": [
                "string",
                "null"
              ],
              "description": "The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD."
            },
            "tokenRequestorId": {
              "type": [
                "string",
                "null"
              ],
              "description": "Numeric string up to 12 digits to identify the system that requested the token."
            },
            "tokenCryptogram": {
              "maxLength": 64,
              "minLength": 0,
              "type": [
                "string",
                "null"
              ],
              "description": "A one-time cryptographic value used to ensure that the token is authorized for the transaction.If provided, this value must be standard Base64-encoded string up to 64 characters long.",
              "format": "byte"
            }
          },
          "additionalProperties": false
        }
      ],
      "properties": {
        "cardType": {
          "title": "NetworkToken",
          "enum": [
            "NetworkToken"
          ],
          "type": "string",
          "description": "Always `NetworkToken`",
          "default": "NetworkToken"
        }
      },
      "description": "Network token details used for this transaction."
    },
    "PanCardInformationDetails": {
      "required": [
        "cardType"
      ],
      "allOf": [
        {
          "$ref": "#/$defs/PaymentInstrumentDetails"
        },
        {
          "type": "object",
          "properties": {
            "cvv": {
              "type": [
                "string",
                "null"
              ],
              "description": "The 3 or 4 digit security code often found on the card. This often referred to as the CVV or CVD."
            }
          },
          "additionalProperties": false
        }
      ],
      "properties": {
        "cardType": {
          "title": "Card",
          "enum": [
            "Card"
          ],
          "type": "string",
          "description": "Always `Card`",
          "default": "Card"
        }
      },
      "description": "PAN card details used for this transaction."
    },
    "PaymentInstrumentDetails": {
      "required": [
        "cardNumber",
        "cardType",
        "expirationDate"
      ],
      "type": "object",
      "properties": {
        "cardType": {
          "type": "string"
        },
        "cardholderName": {
          "type": [
            "string",
            "null"
          ],
          "description": "The cardholder’s name."
        },
        "cardNumber": {
          "minLength": 1,
          "type": "string",
          "description": "The 13-19 digit card number (PAN) or a tokenized card number (network token or wallet token), depending on the card type.",
          "format": "credit-card"
        },
        "expirationDate": {
          "minLength": 1,
          "type": "string",
          "description": "The expiration date of the card or token, depending on the card type. Formatted MM/YY."
        }
      },
      "additionalProperties": false,
      "description": "Represents the payment credentials used for this transaction. This is a polymorphic object whose concrete shape is determined by cardType and may represent a PAN card, network token, or mobile wallet token (Apple Pay or Google Pay). Note that the encrypted contents of this field must be passed in the cardDetailsEncrypted field. All unencrypted card details will be rejected by the API. "
    },
    "PaymentSource": {
      "enum": [
        "ECommerce",
        "Mail",
        "Telephone",
        "Recurring",
        "Installment",
        "CardOnFile"
      ],
      "type": "string",
      "description": "The source of the transaction. Default value is ECommerce"
    },
    "SchemeExtendedRequestData": {
      "type": "object",
      "properties": {
        "mastercardTransactionLinkId": {
          "maxLength": 22,
          "minLength": 22,
          "type": [
            "string",
            "null"
          ],
          "description": "Mastercard Transaction Link Identifier (TLID) used by Mastercard to connect a merchant initiated transaction to the initial customer initiated transaction."
        }
      },
      "additionalProperties": false
    },
    "StatementDescriptor": {
      "type": "object",
      "properties": {
        "name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Merchant’s doing as business (DBA) name that will be shown in the cardholder’s statement"
        },
        "description": {
          "type": [
            "string",
            "null"
          ],
          "description": "A short description about the purchase"
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Merchant’s website URL"
        },
        "phoneNumber": {
          "type": [
            "string",
            "null"
          ],
          "description": "Merchant’s phone number in E.164 standard"
        },
        "city": {
          "type": [
            "string",
            "null"
          ],
          "description": "City that the transaction takes place"
        }
      },
      "additionalProperties": false,
      "description": "This object that allows the merchant to customise the details of the purchase that will be appear in the cardholder’s statement."
    },
    "ThreeDSecureAuthenticationResponse": {
      "enum": [
        "Y",
        "N",
        "U",
        "A",
        "R"
      ],
      "type": "string"
    },
    "ThreeDSecureData": {
      "type": "object",
      "properties": {
        "version": {
          "type": [
            "string",
            "null"
          ],
          "description": "3D Secure version used during the transaction"
        },
        "cavv": {
          "type": [
            "string",
            "null"
          ],
          "description": "Cardholder authentication values generated for the transaction"
        },
        "eci": {
          "type": [
            "string",
            "null"
          ],
          "description": "Electronic commerce indicator"
        },
        "directoryResponse": {
          "$ref": "#/$defs/ThreeDSecureDirectoryResponse"
        },
        "authenticationResponse": {
          "$ref": "#/$defs/ThreeDSecureAuthenticationResponse"
        },
        "directoryTransactionId": {
          "type": [
            "string",
            "null"
          ],
          "description": "Directory server transaction identifier"
        },
        "xid": {
          "type": [
            "string",
            "null"
          ],
          "description": "Unique transaction identifier"
        }
      },
      "additionalProperties": false
    },
    "ThreeDSecureDirectoryResponse": {
      "enum": [
        "C",
        "Y",
        "A",
        "N",
        "R",
        "U"
      ],
      "type": "string"
    }
  }
}