Skip to main content

OrderTransaction

A payment transaction of an Order: the payment method, the amount and the payment state. The order's paymentState is read from its primary transaction.

type OrderTransaction implements Node {
id: ID!
amount: JSON!
createdAt: DateTime!
orderId: ID!
paymentMethodId: ID!
state: String!
updatedAt: DateTime
order: Order
paymentMethod: PaymentMethod
primaryOrder: Order
}

Fields​

OrderTransaction.id ● ID! non-null scalar​

Global identifier for this entity.

OrderTransaction.amount ● JSON! non-null scalar​

Amount of the transaction in the order's currency, as a JSON object with unitPrice, quantity, totalPrice, calculatedTaxes and taxRules. May differ from the order total, e.g. for a partial payment.

OrderTransaction.createdAt ● DateTime! non-null scalar​

Timestamp the transaction was created.

OrderTransaction.orderId ● ID! non-null scalar​

ID of the order the transaction belongs to.

OrderTransaction.paymentMethodId ● ID! non-null scalar​

ID of the payment method of the transaction.

OrderTransaction.state ● String! non-null scalar​

Name of the transaction's payment state (e.g. open, paid, paid_partially, refunded, cancelled). Filterable.

OrderTransaction.updatedAt ● DateTime scalar​

Timestamp of the last update to the transaction.

OrderTransaction.order ● Order object​

OrderTransaction.paymentMethod ● PaymentMethod object​

OrderTransaction.primaryOrder ● Order object​

Interfaces​

Node interface​

Any entity that can be loaded by its global id through the node(id: ID!) query.

Returned By​

orderTransaction query

Member Of​

Order object ● OrderTransactionEdge object