Capture event
This webhook event is triggered when an authorized payment has been captured, indicating that the reserved funds have been successfully transferred from the customer's account. The event provides transaction details and references to the original authorization for complete payment tracking.
Webhook Example
{
"checkoutReference": "lmisd8b2x3wob8xknx6d18z0k46setlx0rnt4zm45a10pcwqwx",
"payfacReference": "3R5TU6ANXRUPA0YP",
"merchantReference": "68699506042896",
"amount": "50000",
"currency": "ISK",
"reason": "",
"success": "true",
"hmacSignature": "Fp/Jt3waPZq1cv1L2GScRWs9gOpcsLF9zOW/WKzi4s8=",
"additionalData": {
"eventType": "Capture",
"authCode": "123457",
"cardNumber": "411111******1111",
"cardUsage": "Debit",
"originalPayfacReference": "OOJWITWVQV42PSE8",
"paymentMethod": "VI",
}
}
info
HMAC key: a43463784d13ead32a9222944a492600ac06c2a5dd9c915e
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 | Reference generated for this capture request. This is not the checkoutReference of the original checkout session — use originalPayfacReference to find the payment. See Reference fields. |
| payfacReference | string | Unique identifier of this capture. It matches the payfacReference returned in the Received response of the request that triggered it. |
| merchantReference | nullable string | The reference you sent in the capture request. May be null when the capture was not made through the API. |
| amount | string | The payment 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 payment errors or declines, helping diagnose specific issues. |
| success | string | Indicates the payment 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. |
| 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 payment. |
| cardNumber | nullable string | A partially masked PAN. |
| cardUsage | nullable string | The source of funds used for a payment. |
| originalPayfacReference | nullable string | The payfacReference of the authorization this capture applies to — the value you sent as payfacReference in the request. Use it to link the event to the payment. |
| paymentMethod | nullable string | The payment method used in the payment. |