☰

Navigation:

Transaction Pos Ecr Session Created

Notification that a transaction for the ECR session has been successfully created and the payment has been successfully processed.

Overview

This webhook is triggered when a session is processed and a transaction is successfully created through the ECR POS integration. Additionally, it confirms that the payment associated with the transaction has been processed.

The webhook will contain relevant data that you can retrieve using the Session Retrieval API call, allowing you to access detailed information about the session and transaction.

You should confirm the payment result with the combination of SessionId and TerminalId parameters. You should then check the Success parameter to validate the status of the transaction and the Amount to validate the amount received, before updating a transaction’s status on your system. As an extra layer of confirmation, you have the option to use the Retrieve Transaction API

Webhook configuration

To enable within the Viva banking app:

1. Log in to Viva, demo or live , and select the required account

2. Visit Settings > API Access > Webhooks

3. Click on the Create Webhook link.
The New Webhook dialog box is displayed

4. Enter your webhook URL in the URL field

5. Click on the Verify link.
If verified successfully, a confirmation message is displayed

6. Contact Viva.com to proceed with the configuration.

Response example

You may find below the sample response with EventTypeId 1802.

{
   "Url":"Your Webhook URL",
   "EventData":{
      "Aid":"A0000000041010",
      "Tid":"16008507",
      "Amount":200,
      "EventId":0,
      "Preauth":false,
      "Success":true,
      "Message":"Transaction successful",
      "SessionId":"8a94263e-397a-4fed-801b-81c0fb1fb3d7",
      "TipAmount":0,
      "MerchantId":"df60929f-2da7-4ef6-a524-06086da89899",
      "OrderCode":"4304117763008507",
      "Installments":0,
      "TerminalId":"16008507",
      "AbortSuccess":false,
      "AbortOperation":false,
      "CurrencyCode":"978",
      "PanEntryMode":"07",
      "TransactionId":"9e30ea9c-b478-4a04-8e2b-a49a40172dac",
      "ReferenceNumber":546615,
      "CashRegisterId":"f6FAf5jCSEGrTIroJiZm4V",
      "DccDetails":null,
      "ShortOrderCode":"4304117763",
      "TransactionTypeId":5,
      "AuthorizationId":"546615",
      "ApplicationLabel":"Mastercard",
      "LoyaltyInfo":null,
      "AadeTransactionId":"116430409546615546615",
      "MerchantReference":null,
      "VerificationMethod":"CONTACTLESS - NO CVM",
      "AbortAckTime":null,
      "RetrievalReferenceNumber":430409546615,
      "PrimaryAccountNumberMasked":"537053******2495",
      "TransactionDateTime":"2024-10-30T09:13:02.306+00:00"
   },
   "Created":"2024-10-30T13:55:46.7808116Z",
   "CorrelationId":"24-304-47BAD60B38F8",
   "EventTypeId":1802,
   "Delay":null,
   "RetryCount":0,
   "RetryDelay":null,
   "MessageId":"7463ef7a-0b74-4253-aa31-ce79230a65e3",
   "RecipientId":"51638f3b-4d32-4837-a47d-b6917953a183",
   "MessageTypeId":512
}

The Property TransactionTypeId can have a variety of values. Please refer to the TransactionTypeId parameter for more information. To see the full list of EventId, please check the section Error Ids under the EFT POS API documentation.

Webhook body

You can find below the body parameters of this webhook

Parameter Description Example
Aid A string indicating the AID of the card. (Used in successful receipts) A000000003101001
Tid The ID of the terminal, as returned in the transaction response 16031291
Amount Total amount authorized, including tip amount 1220
EventId Indicates the error code associated with the transaction. For a complete list of Event IDs and their corresponding error details, please refer to section Error Ids under the EFT POS API documentation. 1000
Preauth Boolean flag indicating a preauth false
Success Indicates successful authorization result true
Message Description of the status Transaction successful
SessionId Transaction session identification - set by the merchant 4bdebe62-c211-4ca0-a994-b2fbea2061c5
TipAmount The amount for the tip which is linked with the payment order 50
MerchantId The MerchantId of the Merchant bdf4c6b3-c26d-4046-b5df-5c443ec39d09
OrderCode Order code of completed sale transaction 2329122555031291
Installments Number of card installments 0
TerminalId The ID of the target terminal, as sent in the original request 16000010
AbortSuccess Indicates whether status of abort operation was successful false
AbortOperation Indicates if this transaction should be aborted false
CurrencyCode The numeric code of the order's currency as defined in ISO 4217 978
PanEntryMode Indicates the method used for PAN entry to initiate a transaction.
For a complete list of PanEntryMode and their corresponding details, please refer to this section. 		07
TransactionId Transaction identification value 580e0bfc-ad68-420f-af02-2900fb74496a
AbortAckTime Timestamp indicating when the POS retrieved the request to abort transaction
CashRegisterId Cash register identification - set by the merchant XDE384678UY
MerchantReference Free text value used by the merchant to reference the transaction for their own records some-reference
AuthorizationId Authorization Id response from the authorizing institution 266207
TransactionTypeId Transaction type: 5 - sale / 4 - refund / 7 - reversal
For a complete list of TransactionTypeId and their corresponding details, please refer to this section.		 5
RetrievalReferenceNumber Unique transaction identification 206922748800
ApplicationLabel Selected application label, VISA / AMEX etc VISA Debit
PrimaryAccountNumberMasked Masked PAN number 479275XXXXXX9999
TransactionDateTime Transaction date time in ISO 8601 format 2022-03-11 19:34:58.0163 +02:00
LoyaltyInfo Details about the loyalty program associated with the transaction
VerificationMethod The payment verification method used CONTACTLESS - NO CVM
ShortOrderCode 10-digit integer 2328182546
ReferenceNumber STAN number 325495
AadeTransactionId An AADE-specific transaction ID 116123456833121690882
DccDetails Details about currency conversion

Get Support

If you would like to integrate with Viva, or if you have any queries about our products and solutions, please see our Contact & Support page to see how we can help!