Choose a version:

OrderTransaction

object

Requires read_orders access scope or read_marketplace_orders access scope.

A payment transaction in the context of an order.

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 manualPaymentGatewaymanualPaymentGateway • Boolean!non-null: Whether the transaction is processed by manual payment gateway.
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-null: The amount of money.
Anchor to amountV2amountV2 • MoneyV2!non-null: The amount and currency of the transaction.
Anchor to maximumRefundablemaximumRefundable • Money: Specifies the available amount to refund on the gateway. This value is only available for transactions of type SuggestedRefund.
Anchor to paymentMethodpaymentMethod • PaymentMethods: The payment method used for the transaction. This value is null if the payment method is unknown.
Anchor to totalUnsettledtotalUnsettled • Money: Specifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Anchor to totalUnsettledV2totalUnsettledV2 • MoneyV2: Specifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.

Was this section helpful?

Anchor to MutationsMutations

Anchor to orderCapture orderCapture • mutation: 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.
Anchor to transactionVoid transactionVoid • mutation: Trigger the voiding of an uncaptured authorization transaction.

Was this section helpful?

Anchor to InterfacesInterfaces

Anchor to Node Node • interface

Was this section helpful?