PCI

Get card info with encrypted PAN V3 [beta]

Get card information - card ID, account ID, customer ID - using a card's encrypted PAN (Primary Account Number). To set up encryption for this endpoint, contact your Pismo representative. Alternatively, to send the PAN as clear text, call the Get card info with PAN endpoint.

This endpoint uses AES256 with the GCM mode. AES-256 GCM is an authenticated encryption mode that uses the Advanced Encryption Standard (AES) with a 256-bit key in Galois/Counter Mode (GCM) to provide both confidentiality and integrity for data. In AES, an initialization vector (IV) is a fixed-size, non-secret randomized number used alongside the secret key to jumpstart the encryption process. The caller is responsible for generating the IV. The Additional Authenticated Data (AAD) parameter must be the organization/tenant ID. AAD, in AES-GCM, is unencrypted data that is authenticated alongside the ciphertext to ensure the message's integrity and authenticity.

Note: This is a PCI endpoint, use the https://gw-pci.pismolabs.io environment.

post/v3/pcicards/cards/search

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/v3/pcicards/cards/search
  • Auth
    HTTP bearer

Request body

panstring

Primary Account Number (PAN) encrypted with AES/GCM/NoPadding algorithm. The ciphertext (PAN encryption result) is REQUIRED to be base64 encoded.

ivstring

Array initialization vector, used as a initial state for the AES algorithm. This field is used on the requester side to encrypt the PAN. It must be an random array of 16 bytes of length encoded as base64

key_idstring

Key ID used for encryption. To obtain the key_id, the sender will generate a symmetric key (AES), encrypt this key with an asymmetric key (public_key) and send it via secure email to the security team.

To obtain the asymmetric key, you must open a Configuration item for the Cards squad. After the Pismo security team registers the symmetric key, the key_id is shared with the issuer.

Example request

{
  "pan": "/5yGTkBSoqGY+Ug5yJuHUSGk54VRMNoY0G5Ni2HSa64=",
  "iv": "ZZ3cUcotvQeaGciyLZb1wA==",
  "key_id": "5c09cda4-8153-11ed-a1eb-0242ac120002"
}

Response

Response for find card success

card_idinteger

Card ID

account_idnumber

Account ID

customer_idinteger

Pismo customer ID

Example response

{
  "account_id": 0,
  "card_id": 0,
  "customer_id": 0
}

Changes

No recorded changes to this operation across all 1 revision of this API.