Skip to content
Saleor
Esc
↑↓navigate↵open⌘Jpreview

Schema: Saleor 3.23.43Download SDLUpgrade guides

On this page

TransactionItem Object

Represents a payment transaction.

type TransactionItem implements Node & ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(key: String!): String
  privateMetafields(keys: [String!]): Metadata
  metadata: [MetadataItem!]!
  metafield(key: String!): String
  metafields(keys: [String!]): Metadata
  token: UUID!
  createdAt: DateTime!
  modifiedAt: DateTime!
  actions: [TransactionActionEnum!]!
  authorizedAmount: Money!
  authorizePendingAmount: Money!
  refundedAmount: Money!
  refundPendingAmount: Money!
  canceledAmount: Money!
  cancelPendingAmount: Money!
  chargedAmount: Money!
  chargePendingAmount: Money!
  name: String!
  message: String!
  pspReference: String!
  order: Order
  checkout: Checkout
  events: [TransactionEvent!]!
  createdBy: UserOrApp
  externalUrl: String!
  paymentMethodDetails: PaymentMethodDetails
  reason: String
  reasonReference: Page
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

The ID of the object.

privateMetadata

privateMetadata · [MetadataItem!]!

List of private metadata items. Requires staff permissions to access.

privateMetafield

privateMetafield · String

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

List of public metadata items. Can be accessed without permissions.

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

keys

keys · [String!]

token

token · UUID!

The transaction token.

createdAt

createdAt · DateTime!

Date and time at which payment transaction was created.

modifiedAt

modifiedAt · DateTime!

Date and time at which payment transaction was modified.

actions

actions · [TransactionActionEnum!]!

List of actions that can be performed in the current state of a payment.

authorizedAmount

authorizedAmount · Money!

Total amount authorized for this payment.

authorizePendingAmount

authorizePendingAmount · Money!

Total amount of ongoing authorization requests for the transaction.

refundedAmount

refundedAmount · Money!

Total amount refunded for this payment.

refundPendingAmount

refundPendingAmount · Money!

Total amount of ongoing refund requests for the transaction.

canceledAmount

canceledAmount · Money!

Total amount canceled for this payment.

cancelPendingAmount

cancelPendingAmount · Money!

Total amount of ongoing cancel requests for the transaction.

chargedAmount

chargedAmount · Money!

Total amount charged for this payment.

chargePendingAmount

chargePendingAmount · Money!

Total amount of ongoing charge requests for the transaction.

name

name · String!

Name of the transaction.

message

message · String!

Message related to the transaction.

pspReference

pspReference · String!

PSP reference of transaction.

order

order · Order

The related order.

checkout

checkout · Checkout

The related checkout.

events

events · [TransactionEvent!]!

List of all transaction’s events.

createdBy

createdBy · UserOrApp

User or App that created the transaction.

externalUrl

externalUrl · String!

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

paymentMethodDetails

paymentMethodDetails · PaymentMethodDetails

The payment method used for this transaction.

Added in Saleor 3.22

reason

reason · String

Reason of the refund.

Added in Saleor 3.22

reasonReference

reasonReference · Page

Reason Page (Model) for refund.

Added in Saleor 3.22

Used by


Schema: Saleor 3.23.43. Download SDL.

Last updated on April 13, 2026

Was this page helpful?