Skip to main content

Tokenization event

This webhook event is triggered when a tokenization request has been successfully completed during a payment, indicating that a new payment token has been created and is ready for use in future transactions. The event includes the generated token along with transaction details and payment method information for secure payment processing.

Webhook Example

{
"checkoutReference": "w4znp75zopqwfpg60jhdz6sjhrgz210zefd5o2bcnmn3i8uu5w",
"payfacReference": "OOJWITWVQV42PSE8",
"merchantReference": "63666423116709",
"amount": "250000",
"currency": "ISK",
"reason": "773206:1111:03/2030",
"success": "true",
"hmacSignature": "ag8i/dlOLFtGTFlDWo0NMhltf6iV4RM7NuNr7wwoUTE=",
"additionalData": {
"eventType": "Tokenization",
"authCode": "123456",
"cardExpiryDate": "30/2030",
"cardNumber": "411111******1111",
"cardSummary": "1111",
"cardUsage": "Debit",
"originalPayfacReference": "OOJWITWVQV42PSE8",
"paymentMethod": "VI",
"threeDAuthenticated": "false",
"token": "69RX6F0Z8119CAB6",
"paymentLinkIdentifier": "78c5ec6ea95477",
"paymentLinkDescription": "Payment for Custom T-shirt Design",
}
}
info

HMAC key: 1dbaa6a7462fe112bbb9ccf5f9fcade62a9016f1b44069e1

Headers

In the Authorization header, we will set the matching Api key for your webhook.

Fields

You will always get these fields.

FieldTypeDescription
checkoutReferencenullable stringUnique identifier for the payment that was done through a hosted checkout.
payfacReferencestringUnique identifier for the transaction generated by the payment service provider.
merchantReferencenullable stringThe identifier for the transaction provided by you, the merchant, allowing for correlation with the merchant’s system.
amountstringThe transaction amount in the minor currency unit.
currencystringThe three-letter ISO currency code.
reasonnullable stringA field that provides additional context in case of transaction errors or declines, helping diagnose specific issues.
successstringIndicates the transaction status (true/false).
hmacSignaturestringA cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
additionalDataobjectAn object for the additional details included in the event.

Additional Data Fields

Fields you will get depend on the event type of the webhook.

FieldTypeDescription
eventTypestringA string representing the type of event that occurred.
authCodenullable stringAn authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card transaction.
cardExpiryDatenullable stringCard expiration date in "MM/yyyy" format.
cardNumbernullable stringA partially masked PAN.
cardSummarynullable stringLast 4 digits of PAN.
cardUsagenullable stringThe source of funds used for a authorization.
originalPayfacReferencenullable stringThis field indicates the payment request associated with the original payment.
paymentMethodnullable stringThe payment method used in the authorization.
threeDAuthenticatednullable stringIndicates if 3D Secure authentication was completed for this authorization.
untokenizedCardSummarynullable stringLast 4 digits of original PAN in case of network payment.
tokenstringA payment token you can use for future payments through API.
paymentLinkIdentifiernullable stringA unique identifier for the payment link used to create authorization.
paymentLinkDescriptionnullable stringA human-readable description of the payment link.