Skip to main content

transactionEventReport Mutation

Report the event for the transaction.

Requires the following permissions: OWNERHANDLE_PAYMENTS for appsHANDLE_PAYMENTS for staff users

Staff user cannot update a transaction that is owned by the app.

Triggers the following webhook events:

  • TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated.
  • CHECKOUT_FULLY_PAID (async): Optionally called when the checkout charge status changed to FULL or OVERCHARGED.
  • ORDER_UPDATED (async): Optionally called when the transaction is related to the order and the order was updated.
transactionEventReport(
  amount: PositiveDecimal
  availableActions: [TransactionActionEnum!]
  externalUrl: String
  id: ID
  message: String
  paymentMethodDetails: PaymentMethodDetailsInput
  pspReference: String!
  time: DateTime
  token: UUID
  transactionMetadata: [MetadataInput!]
  transactionPrivateMetadata: [MetadataInput!]
  type: TransactionEventTypeEnum!
): TransactionEventReport
Show return type

Arguments​

amount ● PositiveDecimal​

The amount of the event to report.

Required for all REQUEST, SUCCESS, ACTION_REQUIRED, and ADJUSTMENT events. For other events, the amount will be calculated based on the previous events with the same pspReference. If not possible to calculate, the mutation will return an error.

availableActions ● [TransactionActionEnum!]​

List of all possible actions for the transaction

externalUrl ● String​

The url that will allow to redirect user to payment provider page with event details.

id ● ID​

The ID of the transaction. One of field id or token is required.

message ● String​

The message related to the event. The maximum length is 512 characters; any text exceeding this limit will be truncated.

paymentMethodDetails ● PaymentMethodDetailsInput​

Details of the payment method used for the transaction.

Added in Saleor 3.22

pspReference ● String!​

PSP Reference of the event to report.

time ● DateTime​

The time of the event to report. If not provide, the current time will be used.

token ● UUID​

The token of the transaction. One of field id or token is required.

transactionMetadata ● [MetadataInput!]​

Fields required to update the transaction metadata. Can be read by any API client authorized to read the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

transactionPrivateMetadata ● [MetadataInput!]​

Fields required to update the transaction private metadata.

Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

type ● TransactionEventTypeEnum!​

Current status of the event to report.

Type​

TransactionEventReport​

Report the event for the transaction.

Requires the following permissions: OWNERHANDLE_PAYMENTS for appsHANDLE_PAYMENTS for staff users

Staff user cannot update a transaction that is owned by the app.

Triggers the following webhook events:

  • TRANSACTION_ITEM_METADATA_UPDATED (async): Optionally called when transaction's metadata was updated.
  • CHECKOUT_FULLY_PAID (async): Optionally called when the checkout charge status changed to FULL or OVERCHARGED.
  • ORDER_UPDATED (async): Optionally called when the transaction is related to the order and the order was updated.