Skip to main content

transaction Query

Look up a transaction by ID.

Requires one of the following permissions: HANDLE_PAYMENTSMANAGE_ORDERS
transaction(
  id: ID
  token: UUID
): TransactionItem
Details
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
}

Arguments​

id ● ID​

ID of a transaction. Either it or token is required to fetch the transaction data.

token ● UUID​

Token of a transaction. Either it or ID is required to fetch the transaction data.

Type​

TransactionItem​

Represents a payment transaction.