Webhook Message

info

In this section, you will find an example of a standardized webhook message, designed to notify your system of payment events. Each field in the webhook message provides essential details for confirming transaction outcomes and ensuring data integrity.

Webhook Example

{
    "checkoutReference": null,
    "payfacReference": "21135253156",
    "merchantReference": "9990QQAZ1221",
    "amount": "48900",
    "currency": "ISK",
    "reason": null,
    "success": "true",
    "hmacSignature": "oH4Sgo4cZ/O8489HQU7TbcvohJkH4eHbz50Q3G+VXfk=",
    "additionalData": {
        "eventType": "Authorization",
        "cardUsage": "Debit",
        "cardNumber": "411111******1142",
        "threeDAuthenticated": "false",
        "cardSummary": "1142",
        "paymentMethod": "VI",
        "authCode": "123456",
    }
}

Headers

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

Fields

You will always get these fields.

Field	Type	Description
checkoutReference	nullable string	Unique identifier for the payment that was done through a hosted checkout.
payfacReference	string	Unique identifier for the transaction generated by the payment service provider.
merchantReference	nullable string	The identifier for the transaction provided by you, the merchant, allowing for correlation with the merchant’s system.
amount	string	The transaction amount in the minor currency unit.
currency	string	The three-letter ISO currency code.
reason	nullable string	A field that provides additional context in case of transaction errors or declines, helping diagnose specific issues.
success	string	Indicates the transaction status (true/false).
hmacSignature	string	A cryptographic signature generated using a secret, enabling verification of the message authenticity and ensuring it hasn’t been tampered with.
additionalData	object	An object for the additional details included in the event.

Additional Data Fields

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

Field	Type	Description
eventType	string	A string representing the type of event that occurred. (Authorization/Capture/Adjustment/Refund)
cardUsage	nullable string	The source of funds used for a transaction.
cardNumber	nullable string	A partially masked PAN.
threeDAuthenticated	nullable string	Indicates if 3D Secure authentication was completed for this payment.
originalPayfacReference	nullable string	This field indicates the payment request associated with the original payment.
paymentMethod	nullable string	The payment method used in the transaction.
cardSummary	nullable string	Last 4 digits of PAN.
authCode	nullable string	An authorization code is a unique series of letters or numbers generated by a card issuer or bank to validate a card transaction.
token	nullable string	A payment token you can use for future payments through API. You will only get this field through the Tokenization event.

Event types

These event types are commonly used in payment processing and refer to different stages of a transaction:

Event Type	Description
Authorization	This event indicates that funds have been reserved from the customer's account for a specific amount. If no specific capture action is set, the system will automatically capture the authorized funds after a short period. In that case we will not send Capture event.
Capture	This event confirms that the authorized funds have been withdrawn from the customer's account.
Adjustment	This event represents a modification to the authorized amount, either increasing or decreasing it.
Refund	This event represents a notification that the refund is processed. It can take up to 40 business days for the funds to be returned to the customer's account, depending on the payment method.
Tokenization	This event represents a notification for when a tokenization request has been successfully completed.