Lithic · Schema

tokenization-approval-request

An event webhook (no responder) to inform that a Tokenization Request was decisioned on.

FinTechBaaSCard IssuingPaymentsEmbedded Finance
View JSON Schema on GitHub

JSON Schema

lithic-tokenization-approval-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/tokenization-approval-request",
  "title": "tokenization-approval-request",
  "description": "An event webhook (no responder) to inform that a Tokenization Request was decisioned on.",
  "allOf": [
    {
      "$ref": "#/components/schemas/tokenization-request-base"
    },
    {
      "type": "object",
      "properties": {
        "token_metadata": {
          "$ref": "#/components/schemas/digital-wallet-token-metadata"
        },
        "customer_tokenization_decision": {
          "oneOf": [
            {
              "type": "null"
            },
            {
              "$ref": "#/components/schemas/customer-tokenization-decision"
            }
          ]
        },
        "event_type": {
          "description": "The name of this event",
          "enum": [
            "tokenization.approval_request"
          ],
          "example": "tokenization.approval_request",
          "type": "string"
        },
        "tokenization_decline_reasons": {
          "description": "List of reasons why the tokenization was declined",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tokenization-decline-reason"
          }
        },
        "tokenization_tfa_reasons": {
          "description": "List of reasons why two-factor authentication was required",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tokenization-tfa-reason"
          }
        },
        "rule_results": {
          "description": "Results from rules that were evaluated for this tokenization",
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/tokenization-rule-result"
          }
        }
      },
      "required": [
        "customer_tokenization_decision",
        "event_type",
        "token_metadata"
      ]
    }
  ],
  "examples": [
    {
      "account_token": "00000000-0000-0000-0000-000000000002",
      "card_token": "00000000-0000-0000-0000-000000000001",
      "created": "2023-09-18T12:34:56Z",
      "customer_tokenization_decision": {
        "latency": "100",
        "outcome": "APPROVED",
        "responder_url": "https://example.com",
        "response_code": "123456"
      },
      "device": {
        "imei": "123456789012345",
        "ip_address": "1.1.1.1",
        "location": "37.3860517/-122.0838511"
      },
      "token_metadata": {
        "payment_account_info": {
          "account_holder_data": {
            "phone_number": "+15555555555"
          },
          "pan_unique_reference": "pan_unique_ref_1234567890123456789012345678",
          "payment_account_reference": "ref_1234567890123456789012",
          "token_unique_reference": "token_unique_ref_1234567890123456789012345678"
        },
        "payment_app_instance_id": "app_instance_123456789012345678901234567890",
        "status": "Pending",
        "token_requestor_id": "12345678901",
        "token_requestor_name": "APPLE_PAY"
      },
      "event_type": "tokenization.approval_request",
      "issuer_decision": "APPROVED",
      "tokenization_channel": "DIGITAL_WALLET",
      "tokenization_source": "PUSH_PROVISION",
      "tokenization_token": "tok_1234567890abcdef",
      "wallet_decisioning_info": {
        "account_score": "100",
        "device_score": "100",
        "recommendation_reasons": [
          "Reason1"
        ],
        "recommended_decision": "Decision1"
      },
      "tokenization_decline_reasons": [],
      "tokenization_tfa_reasons": [
        "WALLET_RECOMMENDED_TFA"
      ],
      "rule_results": [
        {
          "auth_rule_token": "550e8400-e29b-41d4-a716-446655440001",
          "result": "REQUIRE_TFA",
          "name": "CustomerRiskRule",
          "explanation": "High risk transaction detected"
        }
      ]
    }
  ]
}