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
  pspReference: String!
  time: DateTime
  token: UUID
  transactionMetadata: [MetadataInput!]
  transactionPrivateMetadata: [MetadataInput!]
  type: TransactionEventTypeEnum!
): TransactionEventReport

Arguments​

transactionEventReport.amount ● PositiveDecimal scalar miscellaneous​

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.

transactionEventReport.availableActions ● [TransactionActionEnum!] list enum payments​

List of all possible actions for the transaction

transactionEventReport.externalUrl ● String scalar miscellaneous​

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

transactionEventReport.id ● ID scalar miscellaneous​

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

transactionEventReport.message ● String scalar miscellaneous​

The message related to the event.

transactionEventReport.pspReference ● String! non-null scalar miscellaneous​

PSP Reference of the event to report.

transactionEventReport.time ● DateTime scalar miscellaneous​

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

transactionEventReport.token ● UUID scalar miscellaneous​

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

transactionEventReport.transactionMetadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the transaction metadata.

transactionEventReport.transactionPrivateMetadata ● [MetadataInput!] list input miscellaneous​

Fields required to update the transaction private metadata.

transactionEventReport.type ● TransactionEventTypeEnum! non-null enum payments​

Current status of the event to report.

Type​

TransactionEventReport object payments​

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.