# JPMC-PDP Documentation from https://developer.payments.jpmorgan.com # Token provisioning & lifecycle report This report provides detailed insights into the process of tokenization, focusing on the provisioning of tokens and cryptograms for different methods of payment. It also provides a clear overview of the current state of token lifecycles, highlighting the effectiveness of token management practices. **Token lifecycle report details** | Report type | Supported entity types | Supported file formats | | --- | --- | --- | | Token provisioning and lifecycle | - PE - Processing Entity - TD - Transaction Division - BU - Business Unit - FTI - Fund Transfer Instruction - CO - Company - RG - Reporting Group | - Comma Seperated Values (CSV) - Gzip or GNU Zip (GZ) | > You must subscribe to Value Added Services (VAS) to access the report. > ## Use cases - Provides the percentage of tokens and cryptograms successfully requested and provisioned. - Provides the statistics on the number of tokens that are currently usable for processing transactions. - Represents the success rate by the type of payment card , such as Mastercard (MC) & Visa (VI). ## Granularity Method of Payment, Tokens Requested , Tokens Provisioned, Cryptograms Requested, Cryptogram Provisioned, Token State Changes - number of Active Tokens, Inactive Tokens , and Deleted Tokens. ## Fields The following table shows the field details. **Token lifecycle report field details** | Field name | Description | | --- | --- | | Method of Payment | The method used to pay for the exchange of money, goods or services between a merchant and their consumer. Examples: Visa, MasterCard, PayPal, Bill Me Later. Also known as method of payment or MOP. | | Tokens Provisioned | The number of payment tokens that have been successfully provisioned for transaction processing. | | Total Tokens Requested | The number of payment tokens that have been requested. | | Token Provision Success Ratio | The success rate of total token provisioned. | | Cryptograms Provisioned | The number of cryptograms that have been successfully generated. | | Total Cryptograms Requested | The number of cryptograms that have been requested. | | Token Cryptogram Request Success Ratio | The success rate of cryptogram provisioning. | | State Change Update | Updates or changes in the status of a token, such as activation, suspension, or deletion. | | Active Tokens | The number of tokens that are currently active and can be used for transaction processing. | | Inactive or Suspended Tokens | The number of tokens that have been provisioned but are temporarily inactive or suspended. Cannot use these tokens for processing until they are re-activated. | | Deleted Tokens | The number of tokens that have been removed from card-on-file solution and can no longer be used for transaction processing. | ## Sample report configurations The following samples help you get an idea of how to configure token provisioning and lifecycle reports. ### CO/BU/TD The following request code block shows how to configure a token provisioning and lifecycle report for `entityType` = CO/BU/TD. ```json { "entityType": "CO", "entityIds": [ "9999999" ], "reportSections": [ { "sectionTitle": "Token Provisioning & Cryptogram Details", "sectionReportTypeName": "Token Provisioning and Lifecycle", "sectionReportTypeId": "3022", "sectionSelectedFields": [ { "reportAttributeName": "Payment Method Code", "alias": "Method of Payment" }, { "alias": "Tokens Provisioned", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenProvision\",\"InternalTokenProvision\")" }, { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Response Code", "aggregateConditionText": "IN(\"SUCCESS\")" } ] }, { "alias": "Total Tokens Requested", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenProvision\",\"InternalTokenProvision\")" } ] }, { "alias": "Token Provision Success Ratio", "customCalculationText": "Div", "customCalculationOn": "Tokens Provisioned,Total Tokens Requested" }, { "alias": "Cryptograms Provisioned", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenCryptogram\",\"TokenCryptoProcessing\")" }, { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Response Code", "aggregateConditionText": "IN(\"SUCCESS\")" } ] }, { "alias": "Total Cryptograms Requested", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenCryptogram\",\"TokenCryptoProcessing\")" } ] }, { "alias": "Token Cryptogram Request Success Ratio", "customCalculationText": "Div", "customCalculationOn": "Cryptograms Provisioned,Total Cryptograms Requested" } ], "sectionFilterAttributeList": [ { "reportAttributeName": "Payment Method Code", "filterAttributeCode": "!=\"NULL\"" } ] }, { "sectionTitle": "Token Lifecycle Details", "sectionReportTypeName": "Token Provisioning and Lifecycle Report", "sectionReportTypeId": "3022", "sectionSelectedFields": [ { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "State Change Update", "aggregateOperationText": "count" }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Active Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"ACTIVE\")" } ] }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Inactive or Suspended Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"INACTIVE\",\"SUSPENDED\")" } ] }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Deleted Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"DELETED\")" } ] } ] } ], "fileDelimiter": ",", "reportConfigurationName": "Token Provisioning and Lifecycle Report", "reportFileName": "Unified Token Provisioning and Lifecycle Report.....", "reportHeader": "ProcessingEntityID=,ReportType=,Frequency=,FromDate=,ToDate=,GenerationDate=,GenerationTime=", "fileHeader": "BEGIN,EntityId=,Frequency=", "fileTrailer": "END,EntityId=,Frequency=", "csvColumnNameDisplayIndicator": true, "frequencyConfig": { "scheduleFrequency": "adhoc", "reportingPeriodStartTimestamp": "2025-07-01 00:00:00", "reportingPeriodEndTimestamp": "2025-07-31 23:59:00" } } ``` ### PE The following request code block shows how to configure an token provisioning and lifecycle report for `entityType` = PE. ```json { "entityType": "PE", "entityIds": [ "123456" ], "reportSections": [ { "sectionTitle": "Token Provisioning & Cryptogram Details", "sectionReportTypeName": "Token Provisioning and Lifecycle", "sectionReportTypeId": "3022", "sectionSelectedFields": [ { "reportAttributeName": "Payment Method Code", "alias": "Method of Payment" }, { "alias": "Tokens Provisioned", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenProvision\",\"InternalTokenProvision\")" }, { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Response Code", "aggregateConditionText": "IN(\"SUCCESS\")" } ] }, { "alias": "Total Tokens Requested", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenProvision\",\"InternalTokenProvision\")" } ] }, { "alias": "Token Provision Success Ratio", "customCalculationText": "Div", "customCalculationOn": "Tokens Provisioned,Total Tokens Requested" }, { "alias": "Cryptograms Provisioned", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenCryptogram\",\"TokenCryptoProcessing\")" }, { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Response Code", "aggregateConditionText": "IN(\"SUCCESS\")" } ] }, { "alias": "Total Cryptograms Requested", "reportAttributeName": "Unified Payment Gateway Token Management Response Log Identifier", "aggregateOperationText": "distinctCount", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Management Operation Name", "aggregateConditionText": "IN(\"TokenCryptogram\",\"TokenCryptoProcessing\")" } ] }, { "alias": "Token Cryptogram Request Success Ratio", "customCalculationText": "Div", "customCalculationOn": "Cryptograms Provisioned,Total Cryptograms Requested" } ], "sectionFilterAttributeList": [ { "reportAttributeName": "Payment Method Code", "filterAttributeCode": "!=\"NULL\"" } ] }, { "sectionTitle": "Token Lifecycle Details", "sectionReportTypeName": "Token Provisioning and Lifecycle", "sectionReportTypeId": "3022", "sectionSelectedFields": [ { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "State Change Update", "aggregateOperationText": "count" }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Active Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"ACTIVE\")" } ] }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Inactive or Suspended Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"INACTIVE\",\"SUSPENDED\")" } ] }, { "reportAttributeName": "Unified Payment Gateway Token Status Text", "alias": "Deleted Tokens", "aggregateOperationText": "count", "conditionalAggregateIndicator": true, "conditionalAggregateFilterList": [ { "aggregateConditionAttributeName": "Unified Payment Gateway Token Status Text", "aggregateConditionText": "IN(\"DELETED\")" } ] } ] } ], "fileDelimiter": ",", "reportConfigurationName": "Token Provisioning and Lifecycle Report", "reportFileName": "Unified Token Provisioning and Lifecycle Report.....", "reportHeader": "ProcessingEntityID=,ReportType=,Frequency=,FromDate=,ToDate=,GenerationDate=,GenerationTime=", "fileHeader": "BEGIN,EntityId=,Frequency=", "fileTrailer": "END,EntityId=,Frequency=", "csvColumnNameDisplayIndicator": true, "frequencyConfig": { "scheduleFrequency": "adhoc", "reportingPeriodStartTimestamp": "2025-07-01 00:00:00", "reportingPeriodEndTimestamp": "2025-07-31 23:59:00" } } ``` ## Download sample report Download the sample [Token provisioning and lifecycle report](https://raw.githubusercontent.com/jpmorgan-payments/online-payments/refs/heads/main/docs/reporting/Token%20Lifecycle%20Preset%20Report.csv). ## Related [Scheduled and adhoc report configurations](/docs/commerce/optimization-protection/capabilities/reporting/report-configurations/scheduled-adhoc)