Event Code 111 - Apata Finalised Event

The 111 event code is used when Apata sends a finalised event.

{
  "productId": 12345,
  "events": [111],
  "webhookStatus": "active",  
  "config": {
    "url": "https://client_domain.com/webhook",
    "customHeaders": {
      "header1": "value_1",
      "header2": "value_2"
    }
  }
}

After the webhook has been successfully set up, when Apata sends a finalised event, a notification response is sent asynchronously from the Event Delivery Service to the URL specified in the webhook. See the below example of a response.

{
  "context": {
    "notificationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
    "eventCode": 111,
    "eventVersion": "v1",
    "notificationTime": "2024-01-24T23:20:28Z"
  },
  "payload": {
    "version": "V2.0",
    "eventType": "FINALISED_EVENT",
    "transaction": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "dsTransactionId": "98315a91-e0b6-4fe0-8842-9ed82ea8ef0b",
      "threeDsServerTransactionId": "3f9430da-4dd7-473c-b3a3-5100a79deb0d",
      "cardProgramId": "ec737f30-0c61-4383-9732-83d7c7b38b49",
      "riskProfileId": "c0ca8866-27de-4ac6-bdda-8dfc24a74ae9",
      "challengePreference": "NO_PREFERENCE",
      "decoupledPreference": "REQUIRED",
      "amount": 1000,
      "currency": "EUR",
      "recurFrequency": 0,
      "recurEndDate": "2019-08-24",
      "installments": 0,
      "merchantId": "string",
      "merchantName": "string",
      "merchantCountry": "IRL",
      "mcc": "1234",
      "threeDsRequestorId": "string",
      "threeDsRequestorName": "string",
      "threeDsRequestorUrl": "string",
      "threeDsServerReferenceNumber": "string",
      "threeDsServerOperatorId": "string",
      "renderType": "APP_NATIVE",
      "date": "2019-08-24T14:15:22Z",
      "acquirerBin": "123456",
      "authenticationValue": "AABBCCDDEEFFAABBCCDDEEFFAAA=",
      "eci": "string",
      "state": "SUCCEEDED",
      "errorCode": "resource_not_found",
      "reason": "CARD_EXPIRED",
      "exemption": "LOW_VALUE_PAYMENT",
      "protocolVersion": "1.0.2",
      "category": "PAYMENT",
      "transactionType": "PAYMENT",
      "channel": "APP",
      "deviceIP": "string",
      "devicePlatform": "string",
      "deviceModel": "string",
      "deviceOs": "string",
      "deviceOsVersion": "string",
      "deviceLocale": "string",
      "deviceTimezone": "string",
      "deviceAdvertisingId": "string",
      "deviceScreenHeight": 0,
      "deviceScreenWidth": 0,
      "deviceName": "string",
      "deviceLatitude": 0,
      "deviceLongitude": 0,
      "deviceCountry": "string",
      "deviceLanguage": "string",
      "browserAcceptHeader": "string",
      "browserJavaEnabled": true,
      "browserJavascriptEnabled": true,
      "browserColourDepth": 0,
      "browserUtcOffsetMinutes": 0,
      "browserUserAgent": "string"
    },
    "challenges": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "challengeProfileId": "950c886e-8eba-4465-8443-d22f90d269f8",
        "challengeMethodId": "12b5985b-8771-477a-9d02-4528a83cf2b4",
        "challengeMethodAlias": "string",
        "challengeMethodType": "SMS_OTP",
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z",
        "ttl": 300,
        "state": "PENDING"
      }
    ],
    "card": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "externalId": "my-custom-card-reference",
      "language": "en",
      "scheme": "VISA",
      "tags": {
        "property1": "string",
        "property2": "string"
      }
    }
  }
}

The below table describes each of the fields included in the notification response.

Field	Description
context	Object that contains the context of the notification, such as the event code.
notificationId	Unique identifier of the notification.
eventCode	The event code. In this case, the event code is 111.
eventVersion	The event version.
notificationTime	When the notification was created. Time in the UTC format of 'yyyy-MM-ddTHH:mm:ssZ'.
payload	Object that contains the payload of the notification, which is specific to the event code.
version	The version of the event (for example, `V2.0`).
eventType	The type of the event, indicating this is a finalized event.
transaction	Object that contains details of the finalized transaction.
id	The unique identifier for the transaction.
dsTransactionId	The transaction ID assigned by the directory server.
threeDsServerTransactionId	The transaction ID assigned by the 3D Secure server.
cardProgramId	The ID representing the card program used for this transaction.
riskProfileId	The risk profile ID associated with the transaction.
challengePreference	The preference for challenges. For example, `CHALLENGE_MANDATED`.
decoupledPreference	The merchant’s preference for decoupled authentication.
amount	The purchase amount in the currency's minor unit.
currency	The ISO-4217 alpha currency code.
recurFrequency	The minimum number of days between authorisations.
recurEndDate	The date after which no further authorisations should be performed in the format.
installments	The max number of permitted instalment payments.
merchantId	The acquirer-assigned merchant identifier.
merchantName	The merchant name assigned by the Acquirer or Payment System.
merchantCountry	The ISO 3166 alpha country code for the merchant.
mcc	The directory server specific code describing the merchant's type of business, product or service.
threeDsRequestorId	The 3DS requestor ID.
threeDsRequestorName	The name of the 3DS requestor.
threeDsRequestorUrl	The URL of the 3DS requestor.
threeDsServerReferenceNumber	The reference number from the 3DS server.
threeDsServerOperatorId	The operator ID from the 3DS server.
renderType	The format in which the challenge is displayed to the cardholder.
date	The date the transaction was initiated.
acquirerBin	The BIN of the acquirer.
authenticationValue	The authentication value generated for the transaction.
eci	The Electronic Commerce Indicator representing the outcome of authentication.
state	The final status of the transaction.
errorCode	The error code provided for transactions that encountered an error.
reason	The explanation for why the transaction failed or was rejected.
exemption	For frictionless transactions, indicates the exemption type applied.
protocolVersion	The 3DS protocol version.
category	The classification of the transaction (For example, payment, non-payment).
transactionType	The type of transaction being processed.
channel	The channel through which the transaction originated (For example, browser, app).
deviceIP	The IP address of the device used for the transaction.
devicePlatform	The platform of the device used.
deviceModel	The model of the device used for the transaction.
deviceOs	The operating system of the device used.
deviceOsVersion	The operating system version of the device.
deviceLocale	The locale of the device.
deviceTimezone	The timezone of the device.
deviceAdvertisingId	The advertising ID of the device.
deviceScreenHeight	The screen height of the device.
deviceScreenWidth	The screen width of the device.
deviceName	The name of the device.
deviceLatitude	The latitude of the device’s location.
deviceLongitude	The longitude of the device’s location.
deviceCountry	The country of the device user.
deviceLanguage	The language of the device.
browserAcceptHeader	The value of the HTTP Accept header sent by the browser.
browserJavaEnabled	Indicates whether Java is enabled in the browser.
browserJavascriptEnabled	Indicates whether JavaScript is enabled in the browser.
browserColourDepth	The colour depth of the browser.
browserUtcOffsetMinutes	UTC offset in minutes of the browser.
browserUserAgent	The User Agent string of the browser.
transaction	End of the transaction object.
challenges	Object that contains details on the challenges performed if the transaction underwent a challenge.
id	The unique identifier of the challenge.
challengeProfileId	The identifier of the challenge profile in which this challenge method is configured.
challengeMethodId	The identifier of the challenge method used for this challenge.
challengeMethodAlias	The alias of the challenge method used for this challenge.
challengeMethodType	The type of the challenge method used.
created	When the challenge was created.
updated	When the challenge state was last updated.
ttl	The time limit (in seconds) set for completing this challenge.
state	The final status of the challenge.
challenges	End of the challenges object.
card	Object that contains information on the card.
id	The unique identifier of the card generated by Apata.
externalId	The unique identifier of the card generated by the issuer.
language	The ISO 639-1 or BCP-47 language code for the card.
scheme	The payment scheme of the card. For example, `MASTERCARD`.
tags	Object that contains custom tags associated with the card.
property1
property2
tags	End of the tags object.
card	End of the card object.
payload	End of the tags object.

Updated 4 days ago