Skip to content

Create cryptograms

Generate a secure cryptographic verification value for enhanced transaction authentication.

Create a scheme token cryptogram

POST
/v1/token-vault/{ownerType}/{ownerId}/vaults/scheme-tokens/{schemeTokenId}/cryptograms

Request example

Use the following request to create a scheme token cryptogram.

curl -i -X POST \
  https://api-services.pxp.io/api/v1/token-vault/MerchantGroup/MERCHANT-GROUP-1/vaults/scheme-tokens/7d87f401-6977-43a4-8e72-8ff457fc8633/cryptograms

Path parameters

ParameterDescription
ownerId
string (0 to 20 characters)
required
The unique identifier of the entity that owns the token.
ownerType
string (enum)
required
The type of entity that owns the token.

Possible values:
  • Referrer
  • MerchantGroup
  • Merchant
  • Site
schemeTokenId
string (UUID)
required
The unique scheme token ID generated by PXP. It's used as a reference to extract the schemeTokenNumber.

Response example

If your request is successful, you'll receive a 200 response containing a schemeTokenCryptogram.

{
  "schemeTokenCryptogram": "MBvTgcwAAAD6AFQi+dQKAAADFAA=",
  "schemeTokenNumber": "46cae041-de60-44cc-8539-c482d83e38fa",
  "clientPaymentDataId": null
}
ParameterDescription
schemeTokenCryptogram
string 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 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.
schemeTokenNumber
string
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.
clientPaymentDataId
string or null
The client payment data identifier associated with the cryptogram.