Skip to main content
Version: 3.x

TransactionItem

Represents a payment transaction.

Added in Saleor 3.4.

Note: 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!
refundedAmount: Money!
voidedAmount: Money!
chargedAmount: Money!
status: String!
type: String!
reference: String!
order: Order
events: [TransactionEvent!]!
}

Fields

id (ID!)

The ID of the object.

privateMetadata ([MetadataItem!]!)

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

privateMetafield (String)

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

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

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.

Added in Saleor 3.3.

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

metadata ([MetadataItem!]!)

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

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

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

metafields (Metadata)

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

Added in Saleor 3.3.

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

createdAt (DateTime!)

modifiedAt (DateTime!)

actions ([TransactionActionEnum!]!)

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

authorizedAmount (Money!)

Total amount authorized for this payment.

refundedAmount (Money!)

Total amount refunded for this payment.

voidedAmount (Money!)

Total amount voided for this payment.

chargedAmount (Money!)

Total amount charged for this payment.

status (String!)

Status of transaction.

type (String!)

Type of transaction.

reference (String!)

Reference of transaction.

order (Order)

The related order.

Added in Saleor 3.6.

events ([TransactionEvent!]!)

List of all transaction's events.

Interfaces

Node

An object with an ID

ObjectWithMetadata