Decrypt P2PE Data

A single call can decrypt up to 100 values. A success response will only be returned once all values are decrypted and all values to decrypt must belong to a single device.

In JSON, the encrypted property contains an array of objects with name/value properties indicating the values that are to be decrypted. The response will contain an array with the same names in the same order they were submitted and their corresponding decrypted values or individual error information if the data could not be decrypted. If at least one of the values can be decrypted, the overall response will indicate success, but an error code and message will be provided indicating that there were some failures.

The only case that no decrypted values will be returned is if the failure prevents even attempting the decryption of any of the values. The REST endpoint for this call is http://secure-cert.decryptx.com/api/decrypt.

Request Path

POST /api/decrypt

Request Object

This API consumes a JSON object with the following properties.

Response Object

A successful API call outputs a JSON object with the following properties.

cURL Example

Below are an example request and example responses for successful decryption and partially successful decryption. You will receive a partially successful response if at least one of your decryptions succeeded, but others failed.

curl 'https://secure-cert.decryptx.com/api/decrypt' \
    -X POST \
    --header 'Content-Type: application/json' \
    --header 'Accept: application/json'
    -d '{
         "partnerId"  : "?????????",
        "partnerKey" : "ef1ad938150fb15a1384b883a104ce70",
        "reference"  : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
        "serial"     : "541T112708",
        "clientId"   : "bobs_burgers",
        "hasCcData"  : "1",
        "decryptionParameters" : {
            "sequenceNumber" : "629949960E001D200037",
            "encoding"       : "hex"
        },
        "encrypted" : [
            {
                "name"  : "track1",
                "value" : "EF77ABC20DE782C48A88FBF25C59A6C7E21FD7E42D9A1C091F5FC8BBC1BF7DA89E2D8DB1AEB58A7318A79DDE4E59A5E7BD682FCAE9F6BBFD"
            },
            {
                "name"  : "track2",
                "value" : "7EF02FC12FD9864672B4DDAE562F4D6EDAB53D91A85A83964A3E4EA545AD7D6CAFBB9D6BB51016E4"
            }
          ]
        }'

//You will get a response object like the following if the decryption was a success
{
  "success"   : true,
 "reference"  : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
 "messageId"  : "1201607010051161022432609",
  "decrypted" : [
    {
      "name"  : "track1",
      "value" : "25423337303030303939393939393939305e544553542f424c554546494e5e323231323130313132333435363738393f2800000000000000"
    },
    {
      "name"  : "track2",
      "value" : "3b3337303030303939393939393939303d323231323130313132333435363738393f3f0000000000"
    }
  ]
}

{
  "success"   : true,
  "message"   : "One or more values were unable to decrypt, see items for details",
  "code"      : 1302,
  "reference" : "723f57e1-e9c8-48cb-81d9-547ad2b76435",
  "messageId" : "1201607010100381011190531",
  "decrypted" : [
    {
      "name"    : "track1",
      "failed"  : true,
      "message" : "Invalid hex string"
    },
    {
      "name"  : "track2",
      "value" : "3b3337303030303939393939393939303d323231323130313132333435363738393f3f0000000000"
    }
  ]
}

Support for hasCcData Validation

The hasCcData validation flag triggers Decryptx to check incoming and outgoing data for credit card numbers. If hasCcData is set to "1" and the inbound data contains a credit card number, or if the outbound data doesn’t contain credit card number, the decrypt operation will fail. If hasCcData is set to "0", no checks will be performed on inbound and outbound data. The default value is "1".

Some payment terminal manufacturers do not include a complete PAN in their P2PE data, instead they want you to combine a partial decrypted PAN with non-P2PE data in the payload to construct the complete PAN. It is not possible to set hasCcData to "1" when decrypting payloads from these devices. The following table outline device support for hasCcData: