Overview

The "Transaction Data Model" is a Data model type used in your webhook endpoint. This model provides information about any TransactionsStatusChanged event.

Your webhook endpoint will receive a POST request from ECOM that contains an eventType parameter with a value of
"TRANSACTION_STATUS_CHANGED" . It is used to notify your system of the transaction status (success, failed)

Now, we are going to declare the Transaction Status Change Data Model properties of your endpoint and its models along with each accepted parameter and possible value.

Request Model

Fields Description

Field Name	Data Type	Description
`ecomId`	`string`	Unique identifier for the e-commerce transaction.
`paymentStatus`	`string`	Current status of the transaction (e.g., "CAPTURED", "FAILURE").
`product`	`string`	Name or description of the product being purchased. (e.g., "E_LINKS","E_API").
`amount`	`number`	Total amount of the transaction.
`currency`	`string`	Currency code for the transaction (e.g., "KWD").
`invoiceId`	`string`	Unique identifier for the invoice associated with the transaction.
`ecomReference`	`string`	Reference ID provided by the e-commerce platform.
`productPaymentToken`	`string`	Token representing the product payment (used for verification).
`merchantReference`	`string`	Reference ID provided by the merchant for tracking purposes.
`customerFullName`	`string`	Full name of the customer.
`customerPhoneCode`	`string`	Country code for the customer's phone number (e.g., "+965" for the KW).
`customerPhoneNumber`	`string`	Customer's phone number without the country code.
`paymentMethod`	`string`	Method used for payment (e.g., "VISA","MASTERCARD", "KNET").
`paidAt`	`Date`	Timestamp indicating when the payment was completed. (eg "2025-01-30T11:28:33.879Z")
`paymentId`	`string`	Unique identifier for the payment.
`trackingId`	`string`	Identifier used for tracking the transaction.
`referenceId`	`string`	Reference ID associated with the transaction.
`authorizationId`	`string`	Identifier for the payment authorization.
`orderId`	`string`	Unique identifier for the order associated with the transaction.
`transactionId`	`string`	identifier for the payment transaction id.