Skip to main content
Version: 3.x

transactionEventReport

Report the event for the transaction.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.
Requires the following permissions: OWNERHANDLE_PAYMENTS for appsHANDLE_PAYMENTS for staff users

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

transactionEventReport(
amount: PositiveDecimal!
availableActions: [TransactionActionEnum!]
externalUrl: String
id: ID
token: UUID
message: String
pspReference: String!
time: DateTime
type: TransactionEventTypeEnum!
): TransactionEventReport

Arguments

transactionEventReport.amount ● PositiveDecimal! non-null scalar

The amount of the event to report.

transactionEventReport.availableActions ● [TransactionActionEnum!] list enum

List of all possible actions for the transaction

transactionEventReport.externalUrl ● String scalar

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

transactionEventReport.id ● ID scalar

The ID of the transaction. Required if token is not provided.

transactionEventReport.token ● UUID scalar

The token of the transaction. Required if id is not provided.

transactionEventReport.message ● String scalar

The message related to the event.

transactionEventReport.pspReference ● String! non-null scalar

PSP Reference of the event to report.

transactionEventReport.time ● DateTime scalar

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

transactionEventReport.type ● TransactionEventTypeEnum! non-null enum

Current status of the event to report.

Type

TransactionEventReport object

Report the event for the transaction.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.
Requires the following permissions: OWNERHANDLE_PAYMENTS for appsHANDLE_PAYMENTS for staff users

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


Was this page helpful?