Create scheme token cryptogram

Request

Request to create a scheme token cryptogram, a secure cryptographic representation of the token.

Path

ownerIdstring, [ 0 .. 20 ] charactersrequired

The identifier of the vault owner. This must match the owner type. For example, provide your merchant group ID when ownerType is MerchantGroup.

Example:MERCHANT-GROUP-1

ownerTypestringrequired

The type of entity that owns the token vault. Use with ownerId to identify which vault to use.

Enum:"Referrer""MerchantGroup""Merchant""Site"

Example:MerchantGroup

schemeTokenIdstring, (uuid)required

The scheme token ID.

Example:7f46c09d-d1d1-4f94-9a88-6e8ac32e6341

curl -i -X POST \
  https://api-services.pxp.io/api/v1/token-vault/MerchantGroup/MERCHANT-GROUP-1/vaults/scheme-tokens/7f46c09d-d1d1-4f94-9a88-6e8ac32e6341/cryptograms

Responses

Successful creation of the cryptogram

Bodyapplication/json

schemeTokenCryptogramstring or null

A unique cryptogram generated during the tokenisation process, used to enhance the security of transaction processing. This cryptogram acts as a secure and unique identifier, akin to the Token Authentication Verification Value (TAVV), ensuring that each transaction is authenticated and verified without directly using sensitive card details. It plays a crucial role in the secure electronic payment ecosystem, especially in tokenised transactions, by providing an additional layer of security and authentication.

Example:"E1F53135E559C253"

schemeTokenNumberstring

The scheme token number represents a scheme token issued by Visa or Mastercard, used for subsequent transaction processing. This token enhances security and facilitates recurring transactions, providing a secure and efficient alternative to sharing sensitive card details.

Example:"4837261112345678"

cryptogramTypestring or null

The type of cryptogram (e.g., 3DSecure).

Example:"3DSecure"

clientPaymentDataIdstring or null

The client payment data identifier associated with the cryptogram.

Example:"abc123"

Response

{
  "cryptogramType": "3DSecure",
  "clientPaymentDataId": "abc123",
  "schemeTokenCryptogram": "E1F53135E559C253",
  "schemeTokenNumber": "4837261112345678"
}