TransactionItem

Represents a payment transaction.

Added in Saleor 3.4

This API is currently in Feature Preview and can be subject to changes at later point.

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
  createdAt: DateTime!
  modifiedAt: DateTime!
  actions: [TransactionActionEnum!]!
  authorizedAmount: Money!
  authorizePendingAmount: Money!
  refundedAmount: Money!
  refundPendingAmount: Money!
  voidedAmount: Money! @deprecated
  canceledAmount: Money!
  cancelPendingAmount: Money!
  chargedAmount: Money!
  chargePendingAmount: Money!
  status: String! @deprecated
  type: String! @deprecated
  name: String!
  message: String!
  reference: String! @deprecated
  pspReference: String!
  order: Order
  events: [TransactionEvent!]!
  createdBy: UserOrApp
  externalUrl: String!
}

Fields

TransactionItem.id ● ID! non-null scalar

The ID of the object.

TransactionItem.privateMetadata ● [MetadataItem!]! non-null object

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

TransactionItem.privateMetafield ● String scalar

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3

This API is currently in Feature Preview and can be subject to changes at later point.

TransactionItem.privateMetafield.key ● String! non-null scalar

TransactionItem.privateMetafields ● Metadata scalar

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

Added in Saleor 3.3

This API is currently in Feature Preview and can be subject to changes at later point.

TransactionItem.privateMetafields.keys ● [String!] list scalar

TransactionItem.metadata ● [MetadataItem!]! non-null object

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

TransactionItem.metafield ● String scalar

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3

This API is currently in Feature Preview and can be subject to changes at later point.

TransactionItem.metafield.key ● String! non-null scalar

TransactionItem.metafields ● Metadata scalar

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

Added in Saleor 3.3

This API is currently in Feature Preview and can be subject to changes at later point.

TransactionItem.metafields.keys ● [String!] list scalar

TransactionItem.createdAt ● DateTime! non-null scalar

TransactionItem.modifiedAt ● DateTime! non-null scalar

TransactionItem.actions ● [TransactionActionEnum!]! non-null enum

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

TransactionItem.authorizedAmount ● Money! non-null object

Total amount authorized for this payment.

TransactionItem.authorizePendingAmount ● Money! non-null object

Total amount of ongoing authorization requests for the transaction.

Added in Saleor 3.13

TransactionItem.refundedAmount ● Money! non-null object

Total amount refunded for this payment.

TransactionItem.refundPendingAmount ● Money! non-null object

Total amount of ongoing refund requests for the transaction.

Added in Saleor 3.13

TransactionItem.voidedAmount ● Money! deprecated non-null object

DEPRECATED

This field will be removed in Saleor 3.15 (Preview Feature).Use canceledAmount instead.

Total amount voided for this payment.

TransactionItem.canceledAmount ● Money! non-null object

Total amount canceled for this payment.

Added in Saleor 3.13

TransactionItem.cancelPendingAmount ● Money! non-null object

Total amount of ongoing cancel requests for the transaction.

Added in Saleor 3.13

TransactionItem.chargedAmount ● Money! non-null object

Total amount charged for this payment.

TransactionItem.chargePendingAmount ● Money! non-null object

Total amount of ongoing charge requests for the transaction.

Added in Saleor 3.13

TransactionItem.status ● String! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 3.15 (Preview Feature). The status is not needed. The amounts can be used to define the current status of transactions.

Status of transaction.

TransactionItem.type ● String! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 3.15 (Preview Feature). Use name or message instead.

Type of transaction.

TransactionItem.name ● String! non-null scalar

Name of the transaction.

Added in Saleor 3.13

TransactionItem.message ● String! non-null scalar

Message related to the transaction.

Added in Saleor 3.13

TransactionItem.reference ● String! deprecated non-null scalar

DEPRECATED

This field will be removed in Saleor 3.15 (Preview Feature).Use pspReference instead.

Reference of transaction.

TransactionItem.pspReference ● String! non-null scalar

PSP reference of transaction.

Added in Saleor 3.13

TransactionItem.order ● Order object

The related order.

Added in Saleor 3.6

TransactionItem.events ● [TransactionEvent!]! non-null object

List of all transaction's events.

TransactionItem.createdBy ● UserOrApp union

User or App that created the transaction.

Added in Saleor 3.13

TransactionItem.externalUrl ● String! non-null scalar

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

Added in Saleor 3.13

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned by

transaction query

Member of

Checkout object ● Order object ● TransactionActionRequest object ● TransactionCancelationRequested object ● TransactionChargeRequested object ● TransactionCreate object ● TransactionEventReport object ● TransactionInitialize object ● TransactionInitializeSession object ● TransactionItemMetadataUpdated object ● TransactionProcess object ● TransactionProcessSession object ● TransactionRefundRequested object ● TransactionRequestAction object ● TransactionUpdate object