payment-refund

A payment-refund event is triggered when one or more items are returned.

An individual webhook will be sent for every refund trigger that is done and the operationStatus will confirm if the refund payment was successful or not. The transactionID within transaction will provide the transaction key of the payment that is also better detailed on the payment payload of the webhook.

Example:

Properties:

key string
locale object
- appId integer
- countryCode string (maximum length: 3)
- currencyCode string (optional) (maximum length: 3)
- languageCode string (maximum length: 5)
occurredAt string
payload object (object is extensible as desired)
- id integer
- address object (optional)
  - billing object
  - forward object (optional)
  - shipping object
- basketKey string
- confirmedAt string (date-time ISO 8601) (optional)
- contacts array (optional)
  - type string (optional)
  - value string (optional)
- cost object
  - appliedFees array (optional)
  - appliedReductions array (optional)
  - costCapture integer (optional)
  - itemGroups object,null (optional)
  - tax object
  - withoutTax integer
  - withoutTaxWithMembershipDiscount integer (optional)
  - withTax integer
  - withTaxWithMembershipDiscountWithoutServiceCosts integer (optional)
- currencyCode string
- customData object (optional) (object is extensible as desired)
- customer object (optional)
  - id integer
  - anonymisation object (optional)
  - authentication object (optional)
  - birthDate string (optional)
  - customData object (optional) (object is extensible as desired)
  - email string (optional) (maximum length: 60)
  - firstName string
  - gender enum (m f d n) (optional)
  - groups array (optional)
  - identities array (optional)
  - ipAddress string (optional)
  - lastName string
  - phone string (optional)
  - publicKey string (optional) (maximum length: 100)
  - referenceKey string (optional) (maximum length: 100)
  - status object
  - title null,string (optional) (maximum length: 30)
  - type enum (personal retail organization family)
  - userAgent string (optional)
  - createdAt string (date-time ISO 8601)
  - updatedAt string (date-time ISO 8601)
- detailedStatus object (optional) (object is extensible as desired)
  - billing object (object is extensible as desired)
  - order object (object is extensible as desired)
  - shipping object (object is extensible as desired)
- invoicedAt string (date-time ISO 8601) (optional)
- items array (optional)
  - id integer (optional)
  - availableQuantity integer (optional)
  - basketItemKey string (optional)
  - campaignKey string (optional)
  - currency string (optional) (maximum length: 3)
  - customData object (optional) (object is extensible as desired)
  - deliveryForecast object (optional)
  - isManuallyReturnedByCci boolean (optional)
  - itemGroup **** (optional)
  - key string
  - lowestPriorPrice **** (optional)
  - merchant object (optional)
  - packageId integer
  - price object
  - product object (object is extensible as desired)
  - promotion object (optional)
  - reservationKey string (optional)
  - status enum (available unavailable deliverable undeliverable cancelled returned delivered created pended confirmed delegated partially_shipped shipped delivered cancelled)
  - variant object (object is extensible as desired)
  - warehouseId null,integer (optional)
  - warehousePackageGroupId null,integer (optional)
  - createdAt string (date-time ISO 8601)
  - updatedAt string (date-time ISO 8601)
- loyaltyCard object (optional)
  - cardNumber string (optional)
  - points integer
  - provider string ([A-Za-z])
- membershipDiscount object (optional)
  - membershipCardId integer (optional)
  - pointsUsed integer (optional)
  - reductionValue integer (optional)
  - tax integer (optional)
- packages array (optional)
  - id integer
  - carrierKey string (optional)
  - deliveryDate object
  - deliveryStatus enum (open shipment_pending delegation_pending shipment_completed cancellation_completed)
  - hasExpectedAvailabilityAt boolean (optional)
  - returnIdentCode null,string (optional)
  - shipmentKey string (optional)
  - tracking object (optional)
- payment array (optional)
  - amount integer (optional)
  - data object (optional) (object is extensible as desired)
    - success boolean
    - transacation_id string
  - installment array (optional)
  - isGiftCard boolean (optional)
  - key string (optional)
  - options object (optional)
  - transactionKey string (optional)
- promotions array (optional)
  - id string (optional)
  - code string (optional)
  - displayName string (optional)
  - reduction integer (optional)
  - version string (optional)
- publicKey string (optional) (maximum length: 100)
- referenceKey string (optional) (maximum length: 100)
- shipping object (optional)
  - deliveredOn string (optional)
  - deliveryCosts integer (optional)
  - expressDeliveryCosts integer (optional)
  - policy string
- shop object (optional)
  - id integer
  - country string
  - language string
- status enum (order_open payment_pending payment_reserved invoice_completed cancellation_pending cancellation_completed invoice_partially_completed)
- vouchers array (optional)
  - id integer
  - applicableItems array (optional)
  - code string
  - type enum (absolute relative)
  - value number
  - voucherId integer
- transaction object
  - transactionId string
  - operationStatus string
- createdAt string (date-time ISO 8601)
- updatedAt string (date-time ISO 8601)
type enum (payment-refund)