PIpismo
Card migration

Migrate PCI cards

Start migrations of PCI cards.

This endpoint generates the PCI card migration completed event. The result is either SUCCESS or FAIL.

Note: This is a PCI endpoint. Use the <a href="https://gw-pci.pismolabs.io">https://gw-pci.pismolabs.io</a> environment.

post/v1/migrations/cards-pci

Request

  • Base URL
    https://gw-pci.pismolabs.io/migrations
  • URL
    https://gw-pci.pismolabs.io/migrations/v1/migrations/cards-pci
  • Auth
    HTTP bearer

Headers

Authorizationstring required

JSON Web Token (JWT). Tokens expire quickly, which can result in an Unauthorized message. For more information on authentication best practices, refer to Basic authentication with client credentials.

Request body

panstring

Card's PAN (Primary Account Number). If provided, takes precedence over encrypted PAN fields. Either pan or the encrypted PAN fields (key_id, encrypted_pan, iv) are REQUIRED.

Note: The PAN shown here is a fictional example used for documentation purposes. It does not represent a real card number.

pin_blockstring

Card's PIN block password. Must conform to ISO-9564 Format 0 and be encrypted using Zone PIN Key (ZPK). If you do not provide a value in this field, Pismo generates a random password for you.

encrypted_pinstring

Card's PIN block password with two available formats. The first format conforms to ISO-9564 Format 0 and must be encrypted using Zone PIN Key (ZPK). The second format is a PIN offset.

password_triesstring

Cardholder password failure attempts, from 0 to 3.

password_updated'0' | '1'

Is the PIN block password changed? Defaults to changed. 0—Not changed 1—Changed

pin_type'PINOFFSET_IBM3624' | 'PINBLOCK_FORMAT_0' required

Format used for the password. Can be either PINOFFSET_IBM3624 or PINBLOCK_FORMAT_0. When using PINOFFSET_IBM3624, you must use PIN Verification Key (PVK) exchange. For PINBLOCK_FORMAT_0, use Zone PIN Key (ZPK) exchange.

pin_validation_datastring

REQUIRED if pin_type = PINOFFSET_IBM3624. Format = 11-digit primary account number (PAN) + letter N.

service_codestring required

Card service code for Card Verification Value 2 (CVV2). If your virtual card has a different service code, contact your Pismo representative.

key_idstring

Key ID identifying the AES symmetric key registered with Pismo for PAN decryption. REQUIRED when pan is not provided. Must be provided together with encrypted_pan and iv.

encrypted_panstring

Base64-encoded encrypted PAN data using AES/GCM/NoPadding algorithm. REQUIRED when pan is not provided. Must be provided together with key_id and iv.

ivstring

Base64-encoded initialization vector (16 bytes) for AES/GCM decryption. REQUIRED when pan is not provided. Must be provided together with key_id and encrypted_pan.

Example request

{
  "migration": {
    "id": "5a8ade4e-e89a-11eb-9dd1-4b56d86f7a21",
    "version_date": "2021-09-13T19:54:41Z"
  },
  "pan": "123456******7890",
  "pin_block": "670D35C104A6E41F",
  "password_tries": "0",
  "password_updated": "1",
  "pin_validation_data": "59999900017N",
  "service_code": "000",
  "key_id": "pan-key-001",
  "encrypted_pan": "dGVzdC1lbmNyeXB0ZWQtcGFuLWRhdGE=",
  "iv": "YWJjZGVmZ2hpamtsbW5vcA=="
}

Response

Accepted

Changes

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