Public Key

Overview

A Public Key call retrieves the public key used for a specific store and encryption algorithm.

Summary

Action URI Template URI Example Non-URI Request Response
POST /vM.m/stores/[StoreId]/payments/publickey/lookup.xml /vM.m/stores/TMSUS/
payments/publickey/lookup.xml
XML XML Response containing public key configured for the requested store and algorithm version

Request Format

The request is a PublicKeyRequest message.

<?xml version="1.0" encoding="UTF-8"?>
  <PublicKeyRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <AlgorithmVersion>bt4</AlgorithmVersion>
  </PublicKeyRequest>

Request Elements

Element Required Description Type Restriction
AlgorithmVersion Yes The algorithm version of the public key requested String 3-8 Characters

Request Example

<?xml version="1.0" encoding="UTF-8"?>
  <PublicKeyRequest xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <AlgorithmVersion>bt4</AlgorithmVersion>
  </PublicKeyRequest>

Response Format

The response is a PublicKeyReply message.

<?xml version="1.0" encoding="UTF-8"?>
  <PublicKeyReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <PublicKey>{PublicKey}</PublicKey>
  </PublicKeyReply>

Response Elements

Element Required Description Type Restriction
PublicKey Yes The public key for the requested StoreId and algorithm version String 2000 Characters

Response Example

<?xml version="1.0" encoding="UTF-8"?>
  <ProtectPanReply xmlns="http://api.gsicommerce.com/schema/checkout/1.0">
    <Token>4111110PASeK1111</Token>
  </ProtectPanReply>