For the complete documentation index, see llms.txt. This page is also available as Markdown.

Cryptogram File Formats

DUKPT-BDK (Cryptogram)

Line format:

Key Name, KEK Algorithm(optional), KEK (optional), KEK-KCV (optional), Key Algorithm, Cryptogram, KCV, KSI, EKSI (optional)

Rules:

  • Key Name is mandatory.

  • KEK Algorithm, KEK, and KEK-KCV are optional.

    • If present, KEK is encrypted with ZMK.

    • Or use the KEK created on the UI.

    • This in-file KEK encrypts the cryptogram.

  • Key Algorithm is mandatory.

  • Cryptogram is mandatory.

  • KCV is mandatory.

  • KSI is mandatory.

    • Exactly 10 HEX bytes.

  • EKSI is optional.

    • Use it to avoid KSI modification.

    • Provide KSI encrypted with KEK.

  • Each line is one key.

  • Missing optional fields must still keep commas.

    • Unless optional fields are only at the end.

FIXED (Cryptogram)

Line format:

Rules:

  • Key Name is mandatory.

  • KEK Algorithm, KEK, and KEK-KCV are optional.

    • If present, KEK is encrypted with ZMK.

    • Or use the KEK created on the UI.

    • This in-file KEK encrypts the cryptogram.

  • Key Algorithm is mandatory.

  • Cryptogram is mandatory.

  • KCV is mandatory.

  • Each line is one key.

  • Missing optional fields must still keep commas.

    • Unless optional fields are only at the end.

Master Session (MS) (Cryptogram)

Line format:

Rules:

  • Key Name is mandatory.

  • KEK Algorithm, KEK, and KEK-KCV are optional.

    • If present, KEK is encrypted with ZMK.

    • Or use the KEK created on the UI.

    • This in-file KEK encrypts the cryptogram.

  • Key Algorithm is mandatory.

  • Cryptogram is mandatory.

  • KCV is mandatory.

  • KRD-S/N is optional.

    • Terminal S/N.

    • Use it to target a specific terminal.

  • Each line is one key.

  • Missing optional fields must still keep commas.

    • Unless optional fields are only at the end.

Samples:

DUKPT-Initial Keys (IK) (Cryptogram)

Line format:

Rules:

  • Key Name is mandatory.

  • KEK Algorithm, KEK, and KEK-KCV are optional.

    • If present, KEK is encrypted with ZMK.

    • Or use the KEK created on the UI.

    • This in-file KEK encrypts the cryptogram.

  • Cryptogram is mandatory.

  • KCV is mandatory.

  • IKSN is mandatory.

    • Exactly 20 HEX bytes.

  • EIKSN is optional.

    • Use it to avoid IKSN modification.

    • Provide IKSN encrypted with KEK.

  • KRD-S/N is optional.

    • Terminal S/N.

    • Use it to target a specific terminal.

  • Each line is one key.

  • Missing optional fields must still keep commas.

    • Unless optional fields are only at the end.

Samples:

Last updated

Was this helpful?