chargeTransaction.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "name": "chargeTransaction",
  "type": "object",
  "properties": {
    "chargeUuid": {
      "type": "string",
      "description": "Unique ID for the charge that has been transacted"
    },
    "billingProfileId": {
      "type": "string",
      "description": "Billing Profile ID of the charge"
    },
    "transactionId": {
      "type": "string",
      "description": "Unique transaction ID for this transaction"
    },
    "paymentMethodType": {
      "enum": [
        "CARD",
        "DIGITALWALLET",
        "DIRECTDEBIT",
        "CRYPTOCURRENCY"
      ]
    },
    "paymentMethodProvider": {
      "enum": [
        "FORM",
        "PAYPAL",
        "APPLEPAY",
        "GOOGLEPAY",
        "AMAZONPAY"
      ]
    },
    "paymentMethodInputType": {
      "enum": [
        "PHYSICAL",
        "VIRTUAL",
        "PROXY"
      ]
    },
    "paymentMethodIssuer": {
      "type": "string",
      "description": "Payment Method Issuer, e.g. HSBC"
    },
    "paymentMethodId": {
      "type": "string",
      "description": "ID for the payment method token used"
    },
    "paymentScheme": {
      "type": "string",
      "description": "Payment Scheme, e.g. Visa, MasterCard, PayPal Business"
    },
    "transactionType": {
      "enum": [
        "AUTHORIZE",
        "CAPTURE",
        "REFUND",
        "CANCEL",
        "DISPUTE",
        "VERIFY",
        "EXPIRED",
        "INTERNAL"
      ]
    },
    "transactionSubType": {
      "enum": [
        "IDENTIFY",
        "CHALLENGE",
        "CAPTURE_AUTH"
      ]
    },
    "responseCode": {
      "type": "string",
      "description": "ChargeHive Response Code"
    },
    "consumerMessage": {
      "type": "string",
      "description": "Response message designed to display to the consumer"
    },
    "transactionResult": {
      "enum": [
        "SUCCESS",
        "DECLINED",
        "VERIFY",
        "PENDING",
        "PENDING_SUCCESS",
        "RETRY",
        "EXPIRED"
      ]
    },
    "requestedAmount": {
      "$ref": "money.json"
    },
    "transactedAmount": {
      "$ref": "money.json"
    },
    "contractType": {
      "enum": [
        "NONE",
        "PAYMENT",
        "SUBSCRIPTION_INITIAL",
        "SUBSCRIPTION_RENEWAL",
        "ONECLICK"
      ]
    },
    "statementDescriptor": {},
    "failureType": {
      "enum": [
        "NONE",
        "SOFT",
        "HARD",
        "RETRY",
        "INTERNAL"
      ]
    },
    "verificationType": {
      "enum": [
        "INVALID",
        "IDENTIFY",
        "CHALLENGE"
      ]
    },
    "verificationStatus": {
      "enum": [
        "NOT_CHECKED",
        "PASSED",
        "FAILED",
        "CONTINUE"
      ]
    },
    "liability": {
      "enum": [
        "UNKNOWN",
        "MERCHANT",
        "ISSUER"
      ]
    },
    "details": {
      "type": "array",
      "items": {
        "$ref": "transactionDetail.json"
      }
    },
    "attemptDetail": {
      "$ref": "attemptDetail.json"
    },
    "renewalNumber": {
      "type": "number",
      "description": "Renewal number for the subscription"
    },
    "references": {
      "type": "object",
      "description": "References for this transaction"
    },
    "transactionTime": {
      "type": "number",
      "description": "Transaction time, measured in seconds since the Unix epoch"
    },
    "sourceTransactionId": {
      "type": "string",
      "description": "Transaction ID for the source transaction e.g. Original Transaction for a refund, or captureAuth"
    },
    "connectorId": {
      "type": "string",
      "description": "Your ID for the connector used"
    },
    "connectorLibrary": {
      "type": "string",
      "description": "connector library ID used to process this transaction"
    },
    "addressVerificationResult": {
      "type": "string",
      "description": "Address Verification result"
    },
    "cvvVerificationResult": {
      "type": "string",
      "description": "Card Verification result"
    },
    "merchantReference": {
      "type": "string",
      "description": "Unique reference for this charge, as defined by the merchant"
    },
    "responseDetail": {
      "$ref": "responseDetail.json"
    },
    "authCode": {
      "type": "string",
      "description": "This is the authorization code returned by the issuing bank."
    },
    "arn": {
      "type": "string",
      "description": "Acquirer Reference Number"
    },
    "fraudScanResults": {
      "type": "array",
      "items": {
        "$ref": "fraudScan.json"
      }
    }
  }
}