Skip to main content
Anchor to OrderTransaction

OrderTransaction

object

Requires read_orders access scope or read_marketplace_orders access scope.

The OrderTransaction object represents a payment transaction that's associated with an order. An order transaction is a specific action or event that happens within the context of an order, such as a customer paying for a purchase or receiving a refund, or other payment-related activity.

Use the OrderTransaction object to capture the complete lifecycle of a payment, from initial authorization to final settlement, including refunds and currency exchanges. Common use cases for using the OrderTransaction object include:

  • Processing new payments for orders
  • Managing payment authorizations and captures
  • Processing refunds for returned items
  • Tracking payment status and errors
  • Managing multi-currency transactions
  • Handling payment gateway integrations

Each OrderTransaction object has a kind that defines the type of transaction and a status that indicates the current state of the transaction. The object stores detailed information about payment methods, gateway processing, and settlement details.

Learn more about payment processing and payment gateway integrations.

Anchor to FieldsFields

Anchor to accountNumberaccountNumber
•String

The masked account number associated with the payment method.

Anchor to amountRoundingSetamountRoundingSet
•MoneyBag

The rounding adjustment applied on the cash amount in shop and presentment currencies.

Anchor to amountSetamountSet
•MoneyBag!non-null

The amount and currency of the transaction in shop and presentment currencies.

Anchor to authorizationCodeauthorizationCode
•String

Authorization code associated with the transaction.

Anchor to authorizationExpiresAtauthorizationExpiresAt
•DateTime

The time when the authorization expires. This field is available only to stores on a Shopify Plus plan.

Anchor to createdAtcreatedAt
•DateTime!non-null

Date and time when the transaction was created.

Anchor to errorCodeerrorCode
•OrderTransactionErrorCode

A standardized error code, independent of the payment provider.

Anchor to feesfees
•[TransactionFee!]!non-null

The transaction fees charged on the order transaction. Only present for Shopify Payments transactions.

Anchor to formattedGatewayformattedGateway
•String

The human-readable payment gateway name used to process the transaction.

Anchor to gatewaygateway
•String

The payment gateway used to process the transaction.

Anchor to idid
•ID!non-null

A globally-unique ID.

Anchor to kindkind
•OrderTransactionKind!non-null

The kind of transaction.

Anchor to manuallyCapturablemanuallyCapturable
•Boolean!non-null

Whether the transaction can be manually captured.

Anchor to maximumRefundableV2maximumRefundableV2
•MoneyV2

Specifies the available amount with currency to refund on the gateway. This value is only available for transactions of type SuggestedRefund.

Anchor to multiCapturablemultiCapturable
•Boolean!non-null

Whether the transaction can be captured multiple times.

Anchor to orderorder
•Order

The associated order.

Anchor to parentTransactionparentTransaction
•OrderTransaction

The associated parent transaction, for example the authorization of a capture.

Anchor to paymentDetailspaymentDetails
•PaymentDetails

The payment details for the transaction.

Anchor to paymentIconpaymentIcon
•Image

The payment icon to display for the transaction.

Anchor to paymentIdpaymentId
•String

The payment ID associated with the transaction.

Anchor to processedAtprocessedAt
•DateTime

Date and time when the transaction was processed.

Anchor to receiptJsonreceiptJson
•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.

Anchor to settlementCurrencysettlementCurrency
•CurrencyCode

The settlement currency.

Anchor to settlementCurrencyRatesettlementCurrencyRate
•Decimal

The rate used when converting the transaction amount to settlement currency.

Anchor to shopifyPaymentsSetshopifyPaymentsSet
•ShopifyPaymentsTransactionSet

Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan.

Anchor to statusstatus
•OrderTransactionStatus!non-null

The status of this transaction.

Anchor to testtest
•Boolean!non-null

Whether the transaction is a test transaction.

Anchor to totalUnsettledSettotalUnsettledSet
•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.

Anchor to useruser
•StaffMember

Staff member who was logged into the Shopify POS device when the transaction was processed.

Deprecated fields

Anchor to amountamount
•Money!non-nullDeprecated
Anchor to amountV2amountV2
•MoneyV2!non-nullDeprecated
Anchor to maximumRefundablemaximumRefundable
•MoneyDeprecated
Anchor to paymentMethodpaymentMethod
•PaymentMethodsDeprecated
Anchor to totalUnsettledtotalUnsettled
•MoneyDeprecated
Anchor to totalUnsettledV2totalUnsettledV2
•MoneyV2Deprecated
Was this section helpful?

Anchor to MutationsMutations

Anchor to orderCaptureorderCapture
•mutation

Captures payment for an authorized transaction on an order. Use this mutation to claim the money that was previously reserved by an authorization transaction.

The orderCapture mutation can be used in the following scenarios:

  • To capture the full amount of an authorized transaction
  • To capture a partial payment by specifying an amount less than the total order amount
  • To perform multiple captures on the same order, as long as the order transaction is multi-capturable
Note

Multi-capture functionality is only available to stores on a Shopify Plus plan. For multi-currency orders, the currency field is required and should match the presentment currency from the order.

After capturing a payment, you can:

  • View the transaction details including status, amount, and processing information.
  • Track the captured amount in both shop and presentment currencies.
  • Monitor the transaction's settlement status.

Learn more about order transactions.

Arguments

Anchor to inputinput
•OrderCaptureInput!required

The input for the mutation.

Fields

Anchor to transactiontransaction
•OrderTransaction

The created capture transaction.

Anchor to userErrorsuserErrors
•[UserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to transactionVoidtransactionVoid
•mutation

Trigger the voiding of an uncaptured authorization transaction.

Arguments

Anchor to parentTransactionIdparentTransactionId
•ID!required

An uncaptured authorization transaction.

Fields

Anchor to transactiontransaction
•OrderTransaction

The created void transaction.

Anchor to userErrorsuserErrors
•[TransactionVoidUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to NodeNode
•interface
Was this section helpful?
OSZAR »