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
}
Fields
TransactionItem.id
● ID!
non-null scalar miscellaneous
The ID of the object.
TransactionItem.privateMetadata
● [MetadataItem!]!
non-null object miscellaneous
List of private metadata items. Requires staff permissions to access.
TransactionItem.privateMetafield
● String
scalar miscellaneous
A single key from private metadata. Requires staff permissions to access.
Tip: Use GraphQL aliases to fetch multiple keys.
TransactionItem.privateMetafield.key
● String!
non-null scalar miscellaneous
TransactionItem.privateMetafields
● Metadata
scalar miscellaneous
Private metadata. Requires staff permissions to access. Use keys
to control which fields you want to include. The default is to include everything.
TransactionItem.privateMetafields.keys
● [String!]
list scalar miscellaneous
TransactionItem.metadata
● [MetadataItem!]!
non-null object miscellaneous
List of public metadata items. Can be accessed without permissions.
TransactionItem.metafield
● String
scalar miscellaneous
A single key from public metadata.
Tip: Use GraphQL aliases to fetch multiple keys.
TransactionItem.metafield.key
● String!
non-null scalar miscellaneous
TransactionItem.metafields
● Metadata
scalar miscellaneous
Public metadata. Use keys
to control which fields you want to include. The default is to include everything.
TransactionItem.metafields.keys
● [String!]
list scalar miscellaneous
TransactionItem.token
● UUID!
non-null scalar miscellaneous
The transaction token.
TransactionItem.createdAt
● DateTime!
non-null scalar miscellaneous
Date and time at which payment transaction was created.
TransactionItem.modifiedAt
● DateTime!
non-null scalar miscellaneous
Date and time at which payment transaction was modified.
TransactionItem.actions
● [TransactionActionEnum!]!
non-null enum payments
List of actions that can be performed in the current state of a payment.
TransactionItem.authorizedAmount
● Money!
non-null object miscellaneous
Total amount authorized for this payment.
TransactionItem.authorizePendingAmount
● Money!
non-null object miscellaneous
Total amount of ongoing authorization requests for the transaction.
TransactionItem.refundedAmount
● Money!
non-null object miscellaneous
Total amount refunded for this payment.
TransactionItem.refundPendingAmount
● Money!
non-null object miscellaneous
Total amount of ongoing refund requests for the transaction.
TransactionItem.canceledAmount
● Money!
non-null object miscellaneous
Total amount canceled for this payment.
TransactionItem.cancelPendingAmount
● Money!
non-null object miscellaneous
Total amount of ongoing cancel requests for the transaction.
TransactionItem.chargedAmount
● Money!
non-null object miscellaneous
Total amount charged for this payment.
TransactionItem.chargePendingAmount
● Money!
non-null object miscellaneous
Total amount of ongoing charge requests for the transaction.
TransactionItem.name
● String!
non-null scalar miscellaneous
Name of the transaction.
TransactionItem.message
● String!
non-null scalar miscellaneous
Message related to the transaction.
TransactionItem.pspReference
● String!
non-null scalar miscellaneous
PSP reference of transaction.
TransactionItem.order
● Order
object orders
The related order.
TransactionItem.checkout
● Checkout
object checkout
The related checkout.
TransactionItem.events
● [TransactionEvent!]!
non-null object payments
List of all transaction's events.
TransactionItem.createdBy
● UserOrApp
union miscellaneous
User or App that created the transaction.
TransactionItem.externalUrl
● String!
non-null scalar miscellaneous
The url that will allow to redirect user to payment provider page with transaction details.
TransactionItem.paymentMethodDetails
● PaymentMethodDetails
interface miscellaneous
The payment method used for this transaction.
Added in Saleor 3.22TransactionItem.reason
● String
scalar miscellaneous
Reason of the refund.
Added in Saleor 3.22TransactionItem.reasonReference
● Page
object pages
Reason Page
(Model) for refund.
Interfaces
Node
interface miscellaneous
An object with an ID
ObjectWithMetadata
interface miscellaneous
Returned By
transaction
query
Member Of
Checkout
object ● Order
object ● OrderGrantedRefund
object ● TransactionCancelationRequested
object ● TransactionChargeRequested
object ● TransactionCreate
object ● TransactionEventReport
object ● TransactionInitialize
object ● TransactionInitializeSession
object ● TransactionItemMetadataUpdated
object ● TransactionProcess
object ● TransactionProcessSession
object ● TransactionRefundRequested
object ● TransactionRequestAction
object ● TransactionRequestRefundForGrantedRefund
object ● TransactionUpdate
object