Decrypt P2PE data

post

https://example.com/api/decrypt

This allows a partner to decrypt P2PE data from a device. Up to 100 values can be decrypted in a single call. However, it should be noted that a 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 a success, but an error code and message will be provided where there are failures. The API response will only indicate a failure when all decryptions fail.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

P2PE Data Details.

partnerId

string

ID provided by Bluefin for access to the Decryptx API.

partnerKey

string

API Key provided by Bluefin for access to the Decryptx API. This value can be changed on request from the partner or by the partner via the Decryptx portal.

reference

string

A string (of up to 50 characters) that helps partners identify individual API calls. If provided, the value will be logged to the P2PE Manager where it can be used to troubleshoot technical issues. It is highly recommended that a unique value be used on each Decryptx API call. The reference value will be returned in the response body, whether the API call is successful or not.

serial

string

required

The serial number of the device.

firmware

string

The firmware version of the device as captured from the read.

clientId

string

Identifier for partner client to which this device belongs. This value is configured by the partner when the device is provisioned and is optional. This parameter provides an additional level of uniqueness in case device serial numbers are not unique between manufacturers. It also provides a more detailed level of reporting as API usage can be reported to the Client level. All devices provisioned for a partner must have a unique combination of Serial Number and Client. If a partner does not wish to use a client identifier, all devices provisioned for that partner must have a unique Serial Number.

hasCcData

string

enum

required

Defaults to 1

Validation flag that indicates whether inbound and outbound data should be checked for credit card numbers. If hasCcData is set to "1" and the inbound data contains a credit card number or if the outbound data does not 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. If no value for hasCcData flag provided, Decryptx defaults it to "1".

Allowed:

decryptionParameters

object

required

encrypted

array of objects

required

encrypted*

Responses

200Response Object

400DecryptxError

409DecryptxError

500DecryptxError