Skip to main content
View Markdown

TransactionRefundRequested Object

Event sent when transaction refund is requested.

type TransactionRefundRequested implements Event {
  issuedAt: DateTime
  version: String
  issuingPrincipal: IssuingPrincipal
  recipient: App
  transaction: TransactionItem
  action: TransactionAction!
  idempotencyKey: String!
  grantedRefund: OrderGrantedRefund
}

Fields​

issuedAt ● DateTime​

Time of the event.

version ● String​

Saleor version that triggered the event.

issuingPrincipal ● IssuingPrincipal​

The user or application that triggered the event.

recipient ● App​

The application receiving the webhook.

transaction ● TransactionItem​

Look up a transaction.

action ● TransactionAction!​

Requested action data.

idempotencyKey ● String!​

Idempotency key assigned to this requested action. Saleor's delivery retries of this request carry the same key, so an app can use it to avoid performing the action twice. Requesting the action again is a new request and gets a new key.

Added in Saleor 3.23

grantedRefund ● OrderGrantedRefund​

Granted refund related to refund request.

This API is currently in Feature Preview and can be subject to changes at later point.

Interfaces​

Event​