OrderTransaction - admin-graphql - OBJECT

Version: 2024-10

Description:

A payment transaction in the context of an order.

Access Scopes

`read_orders` access scope or `read_marketplace_orders` access scope.

Fields

  • accountNumber: String - The masked account number associated with the payment method.
  • amount: Money! - The amount of money.
  • amountRoundingSet: MoneyBag - The rounding adjustment applied on the cash amount in shop and presentment currencies.
  • amountSet: MoneyBag! - The amount and currency of the transaction in shop and presentment currencies.
  • amountV2: MoneyV2! - The amount and currency of the transaction.
  • authorizationCode: String - Authorization code associated with the transaction.
  • authorizationExpiresAt: DateTime - The time when the authorization expires. This field is available only to stores on a Shopify Plus plan.
  • createdAt: DateTime! - Date and time when the transaction was created.
  • errorCode: OrderTransactionErrorCode - A standardized error code, independent of the payment provider.
  • fees: TransactionFee! - The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.
  • formattedGateway: String - The human-readable payment gateway name used to process the transaction.
  • gateway: String - The payment gateway used to process the transaction.
  • id: ID! - A globally-unique ID.
  • kind: OrderTransactionKind! - The kind of transaction.
  • manuallyCapturable: Boolean! - Whether the transaction can be manually captured.
  • maximumRefundable: Money - Specifies the available amount to refund on the gateway. This value is only available for transactions of type `SuggestedRefund`.
  • maximumRefundableV2: MoneyV2 - Specifies the available amount with currency to refund on the gateway. This value is only available for transactions of type `SuggestedRefund`.
  • multiCapturable: Boolean! - Whether the transaction can be captured multiple times.
  • order: Order - The associated order.
  • parentTransaction: OrderTransaction - The associated parent transaction, for example the authorization of a capture.
  • paymentDetails: PaymentDetails - The payment details for the transaction.
  • paymentIcon: Image - The payment icon to display for the transaction.
  • paymentId: String - The payment ID associated with the transaction.
  • paymentMethod: PaymentMethods - The payment method used for the transaction. This value is `null` if the payment method is unknown.
  • processedAt: DateTime - Date and time when the transaction was processed.
  • receiptJson: JSON - The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction.
  • settlementCurrency: CurrencyCode - The settlement currency.
  • settlementCurrencyRate: Decimal - The rate used when converting the transaction amount to settlement currency.
  • shopifyPaymentsSet: ShopifyPaymentsTransactionSet - Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan.
  • status: OrderTransactionStatus! - The status of this transaction.
  • test: Boolean! - Whether the transaction is a test transaction.
  • totalUnsettled: Money - Specifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
  • totalUnsettledSet: MoneyBag - Specifies the available amount with currency to capture on the gateway in shop and presentment currencies. Only available when an amount is capturable or manually mark as paid.
  • totalUnsettledV2: MoneyV2 - Specifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
  • user: StaffMember - Staff member who was logged into the Shopify POS device when the transaction was processed.

Connections

Related queries

Related mutations

  • orderCapture Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. orderCapture can be used to capture multiple times as long as the OrderTransaction is multi-capturable. To capture a partial payment, the included `amount` value should be less than the total order amount. Multi-capture is available only to stores on a Shopify Plus plan.
  • transactionVoid Trigger the voiding of an uncaptured authorization transaction.

Related Unions

Examples