Data Model
Overview
The "Refund Status Data Model" is a Data model type used in your webhook endpoint. This model provides information about any RefundStatusChanged event.
Your webhook endpoint will receive a POST request from ECOM that contains an eventType parameter with a value of
"REFUND_STATUS_CHANGED" . It is used to notify your system of the refund status .
Now, we are going to declare the Refund 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 |
---|---|---|
refundId | string | Unique identifier for the refund. |
status | string | Status of the refund. (REFUNDED,REJECTED) |
product | string | Product associated with the refund. |
amount | number | Amount refunded. |
currency | string | Currency of the refunded amount. |
paymentMethod | string | Payment method used for the original transaction. |
refundedAt | Date | Timestamp when the refund was processed. |
originalEcomId | string | Original transaction ID associated with the refund. |
customerFullName | string | Full name of the customer. |
customerPhoneCode | string | Phone code of the customer. |
customerPhoneNumber | string | Phone number of the customer. |
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. |