Webhook Notifications

Webhook notifications are automated messages sent by Nayax to your back-end to communicate the final status of a transaction, which can be:

  • Approved
  • Declined
  • Pending

This ensures that you are always up-to-date with the latest transaction information.

📘

Webhook URL

You will provide the URL to receive the webhooks during the onboarding phase.

Webhook Request

Below you can see an example of a webhook of an approved transaction:

{
  "Status": {
    "Verdict": "Approved",
    "Code": 0,
    "StatusMessage": "Transaction successfully completed."
  },
  "BasicInfo": {
    "transactionId": 123456789,
    "AuthCode": "AUTH12345",
    "AuthAmount": 15.00,
    "CaptureAmount": 15.00,
    "RRN": "987654321012",
    "AuthDateTime": "2025-08-28T12:00:00Z",
    "Entry Mode": 1,
    "currencyCode": 840,
    "TransactionEcomMID": "ECOMTRX001",
    "Currency": "USD",
    "CardholderEmail": "[email protected]",
    "NayaxToken": "nayax_token_xyz123",
    "IsAproved": true,
    "Card holder Unique identifier": "guid-customer-12345"
  },
  "Products": [
    {
      "Code": 101,
      "Value": 10,
      "quantity": 1
    },
    {
      "Code": 102,
      "Value": 5,
      "quantity": 1
    }
  ],
  "CardData": {
    "CardNumber": "411111xxxxxx1111",
    "Card expiration": 2810
  }
}

The request includes detailed information about the transaction's final status, including the following objects:

  • Status
  • BasicInfo
  • Products
  • CardData
🚧

Response

We expect to receive a 200 ACK response after every webhook.

Webhook Request Parameters

The table below describes all the parameters of the request:

ParameterTypeDescription
refusalReasonRawRaw response from the acquirer indicating the reason for refusal.
eciElectronic Commerce Indicator, indicates the security level of the transaction.
metadata.actionTypeCustom metadata indicating the type of action performed.
xidTransaction ID used in 3D Secure authentication.
threeDAuthenticatedIndicates whether 3D Secure authentication was completed.
paymentMethodVariantSpecific variant of the payment method used.
issuerBinBank Identification Number of the card issuer.
deviceTypeType of device used by the consumer.
threeDOfferedIndicates whether 3D Secure was offered.
threeDOfferedResponseResponse to the 3D Secure offer.
checkout.cardAddedBrandBrand of the card added during checkout.
cavvCardholder Authentication Verification Value from 3D Secure.
authorisedAmountCurrencyCurrency of the authorised amount.
threeDAuthenticatedResponseResponse from the 3D Secure authentication.
metadata.machineId Custom metadata indicating the machine ID.
threeds2.cardEnrolledIndicates if the card is enrolled in 3DS2.
avsResultRawRaw result of the Address Verification System check.
retry.attempt1.rawResponse Raw response from the first retry attempt.
paymentMethodPayment method used.
shopperLocaleLocale of the consumer.
metadata.decimalPlaceCustom metadata indicating decimal precision.
captureDelayHoursDelay in hours before capturing the payment.
avsResult Human-readable AVS result.
cardSummaryLast few digits of the card number.
retry.attempt1.avsResultRawAVS result from the first retry attempt.
shopperIPIP address of the consumer.
expiryDateExpiry date of the card.
cardBinBank Identification Number of the card.
shopperInteractionType of interaction (e.g., Ecommerce, ContAuth).
cvcResultRawRaw result of the CVC check.
cardIssuingCountryCountry of the card issuer.
metadata.entryModeCustom metadata indicating how the card was entered.
liabilityShiftIndicates if liability shifted to the issuer.
authCodeAuthorisation code from the acquirer.
cardHolderNameName of the cardholder.
isCardCommercialIndicates if the card is a commercial card.
PaymentAccountReferenceReference to the payment account.
retry.attempt1.acquirerAccountAcquirer account used in retry.
retry.attempt1.acquirerAcquirer used in retry.
authorisedAmountValue Value of the authorised amount.
issuerCountryCountry of the card issuer.
cvcResultHuman-readable result of the CVC check.
retry.attempt1.responseCodeResponse code from the retry attempt.
aliasTypeType of alias used for tokenisation.
retry.attempt1.shopperInteractionConsumer interaction type in retry.
cardPaymentMethodCard payment method used.
amount.currencyCurrency of the transaction amount.
amount.valueValue of the transaction amount.
eventCodeType of event triggered.
eventDateDate and time of the event.
operationsPossible operations for the transaction.
success Indicates if the event was successful.

See Also