OrderTransaction object

A transaction represents an exchange of money as part of an order.

Required access

read_orders access scope.

On this page

• Fields
• Types that return OrderTransaction
• Implements
• Deprecated fields
• Samples

Fields

• accountNumber ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The masked account number associated with the payment method.
• amountSet ([MoneyBag!](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneybag))
  The amount and currency of the transaction in shop and presentment currencies.
• authorizationCode ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Authorization code associated with the transaction.
• authorizationExpiresAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  The time when the authorization expires. This field is available only to stores on a Shopify Plus plan and is populated only for Shopify Payments authorizations.
• createdAt ([DateTime!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the transaction was created.
• errorCode ([OrderTransactionErrorCode](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransactionerrorcode))
  A standardized error code, independent of the payment provider.
• fees ([[TransactionFee!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/transactionfee))
  The transaction fees charged on the order transaction.
• formattedGateway ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The human-readable payment gateway name used to process the transaction.
• gateway ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  The payment gateway used to process the transaction.
• id ([ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01))
  Globally unique identifier.
• kind ([OrderTransactionKind!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransactionkind))
  The kind of transaction.
• manuallyCapturable ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the transaction can be manually captured.
• maximumRefundableV2 ([MoneyV2](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/moneyv2))
  Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
• order ([Order](https://shopify.dev/docs/admin-api/graphql/reference/orders/order))
  The associated order.
• parentTransaction ([OrderTransaction](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
  The associated parent transaction, for example the authorization of a capture.
• paymentIcon ([Image](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/image))
  Specifies the payment icon to display for this transaction.

• processedAt ([DateTime](https://shopify.dev/docs/admin-api/graphql/reference/scalar#datetime-2021-01))
  Date and time when the transaction was processed.
• settlementCurrency ([CurrencyCode](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/currencycode))
  The settlement currency.
• settlementCurrencyRate ([Decimal](https://shopify.dev/docs/admin-api/graphql/reference/scalar#decimal-2021-01))
  The rate used when converting the transaction amount to settlement currency.
• shopifyPaymentsSet ([ShopifyPaymentsTransactionSet](https://shopify.dev/docs/admin-api/graphql/reference/orders/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!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransactionstatus))
  The status of this transaction.
• test ([Boolean!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#boolean-2021-01))
  Whether the transaction is a test transaction.
• totalUnsettledSet ([MoneyBag](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/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.

Types that return OrderTransaction

• [Order.transactions](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#transactions-2021-01)
• [OrderTransaction.parentTransaction](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction#parenttransaction-2021-01)
• [Refund.transactions](https://shopify.dev/docs/admin-api/graphql/reference/orders/refund#transactions-2021-01)
• [SuggestedOrderTransaction.parentTransaction](https://shopify.dev/docs/admin-api/graphql/reference/orders/suggestedordertransaction#parenttransaction-2021-01)

Implements

• [Node](https://shopify.dev/docs/admin-api/graphql/reference/common-objects/node)

Deprecated fields

Show/Hide

An auto-generated type for paginating through multiple OrderTransactions.

On this page

• Fields

Fields

• edges ([[OrderTransactionEdge!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
  A list of edges.
• pageInfo ([PageInfo!](https://shopify.dev/docs/admin-api/graphql/reference/pageinfo))
  Information to aid in pagination.

An auto-generated type which holds one OrderTransaction and a cursor during pagination.

On this page

• Fields
• Types that return OrderTransactionEdge

Fields

• cursor ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  A cursor for use in pagination.
• node ([OrderTransaction!](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction))
  The item at the end of OrderTransactionEdge.

Types that return OrderTransactionEdge

• [OrderTransactionConnection.edges](https://shopify.dev/docs/admin-api/graphql/reference/orders/ordertransaction#edges-2021-01)