Payment Card¶
See Payment Card for more information about this algorithm framework.
Creating a Payment Card Algorithm via API¶
-
Retrieve the frameworkId for the Payment Framework. This information can be retrieved using the following endpoint:
algorithm GET /algorithm/frameworks
The framework information should look similar to the following:
{ "frameworkId": 4, "frameworkName": "Payment Card", "frameworkType" : "STRING", "plugin" : { "pluginId" : 7, "pluginName" : "dlpx-core" } }
-
Create a Payment Card algorithm via the following endpoint:
algorithm POST /algorithms
Configure a new algorithm using the JSON formatted input similar to the following:
{ "algorithmName": "examplePaymentCardAlgorithm", "algorithmType": "COMPONENT", "frameworkId" : 4, "algorithmExtension" : { "minMaskedPositions" : 7, "preserve" : 4 } }
Payment Card Algorithm Extension¶
-
minMaskedPositions (default=1, minValue=0, maxValue=32)
Integer
A value that represents the minimum number of positions that must be replaced for masking to be considered successful. A non-conformant data error is thrown when fewer positions are masked. The minimum value for this field is 0 and the default value is 1. The maximum value is 32. -
preserve (default=0, minValue=0, maxValue=32)
Integer
A value that represents the number of maskable characters to preserve at the beginning of the input. Only maskable characters are considered when determining whether a position is preserved. The minimum value for this field is 0 and the default value is 0. The maximum value is 32.