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
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.
key ● String!
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 ● [String!]
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.
key ● String!
metafields ● Metadata
Public metadata. Use keys to control which fields you want to include. The default is to include everything.
keys ● [String!]
token ● UUID!
The transaction token.
createdAt ● DateTime!
Date and time at which payment transaction was created.
modifiedAt ● DateTime!
Date and time at which payment transaction was modified.
actions ● [TransactionActionEnum!]!
List of actions that can be performed in the current state of a payment.
authorizedAmount ● Money!
Total amount authorized for this payment.
authorizePendingAmount ● Money!
Total amount of ongoing authorization requests for the transaction.
refundedAmount ● Money!
Total amount refunded for this payment.
refundPendingAmount ● Money!
Total amount of ongoing refund requests for the transaction.
canceledAmount ● Money!
Total amount canceled for this payment.
cancelPendingAmount ● Money!
Total amount of ongoing cancel requests for the transaction.
chargedAmount ● Money!
Total amount charged for this payment.
chargePendingAmount ● Money!
Total amount of ongoing charge requests for the transaction.
name ● String!
Name of the transaction.
message ● String!
Message related to the transaction.
pspReference ● String!
PSP reference of transaction.
order ● Order
The related order.
checkout ● Checkout
The related checkout.
events ● [TransactionEvent!]!
List of all transaction's events.
createdBy ● UserOrApp
User or App that created the transaction.
externalUrl ● String!
The url that will allow to redirect user to payment provider page with transaction details.
paymentMethodDetails ● PaymentMethodDetails
The payment method used for this transaction.
Added in Saleor 3.22reason ● String
Reason of the refund.
Added in Saleor 3.22reasonReference ● Page
Reason Page (Model) for refund.
Interfaces
Node
An object with an ID
ObjectWithMetadata
Returned By
transaction query
Member Of
Checkout object ● Order object ● OrderGrantedRefund object ● TransactionCancelationRequested object ● TransactionChargeRequested object ● TransactionCountableEdge object ● TransactionCreate object ● TransactionEventReport object ● TransactionInitialize object ● TransactionInitializeSession object ● TransactionItemMetadataUpdated object ● TransactionProcess object ● TransactionProcessSession object ● TransactionRefundRequested object ● TransactionRequestAction object ● TransactionRequestRefundForGrantedRefund object ● TransactionUpdate object