Home > @infiniteobjects/shopify-data-manager > AdminTypes > OrderTransaction
A payment transaction in the context of an order.
Signature:
export interface OrderTransaction extends Node
Extends: Node
| Property | Modifiers | Type | Description |
|---|---|---|---|
| accountNumber? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The masked account number associated with the payment method. | |
| amount | Scalars[‘Money’][‘output’] | The amount of money. | |
| amountSet | MoneyBag | The amount and currency of the transaction in shop and presentment currencies. | |
| amountV2 | MoneyV2 | The amount and currency of the transaction. | |
| authorizationCode? | Maybe<Scalars[‘String’][‘output’]> | (Optional) Authorization code associated with the transaction. | |
| authorizationExpiresAt? | Maybe<Scalars[‘DateTime’][‘output’]> | (Optional) 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 | Scalars[‘DateTime’][‘output’] | Date and time when the transaction was created. | |
| errorCode? | Maybe<OrderTransactionErrorCode | `${OrderTransactionErrorCode}`> | (Optional) A standardized error code, independent of the payment provider. | |
| fees | Array<TransactionFee> | The transaction fees charged on the order transaction. Only present for Shopify Payments transactions. | |
| formattedGateway? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The human-readable payment gateway name used to process the transaction. | |
| gateway? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The payment gateway used to process the transaction. | |
| id | Scalars[‘ID’][‘output’] | A globally-unique ID. | |
| kind | OrderTransactionKind | `${OrderTransactionKind}` | The kind of transaction. | |
| manuallyCapturable | Scalars[‘Boolean’][‘output’] | Whether the transaction can be manually captured. | |
| maximumRefundable? | Maybe<Scalars[‘Money’][‘output’]> | (Optional) Specifies the available amount to refund on the gateway. This value is only available for transactions of type SuggestedRefund. |
|
| maximumRefundableV2? | Maybe<MoneyV2> | (Optional) Specifies the available amount with currency to refund on the gateway. This value is only available for transactions of type SuggestedRefund. |
|
| order? | Maybe<Order> | (Optional) The associated order. | |
| parentTransaction? | Maybe<OrderTransaction> | (Optional) The associated parent transaction, for example the authorization of a capture. | |
| paymentDetails? | Maybe<PaymentDetails> | (Optional) The payment details for the transaction. | |
| paymentIcon? | Maybe<Image> | (Optional) The payment icon to display for the transaction. | |
| paymentId? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The payment ID associated with the transaction. | |
| paymentMethod? | Maybe<PaymentMethods | `${PaymentMethods}`> | (Optional) The payment method used for the transaction. This value is null if the payment method is unknown. |
|
| processedAt? | Maybe<Scalars[‘DateTime’][‘output’]> | (Optional) Date and time when the transaction was processed. | |
| receipt? | Maybe<Scalars[‘String’][‘output’]> | (Optional) The transaction receipt that the payment gateway attaches to the transaction. The value of this field depends on which payment gateway processed the transaction. | |
| receiptJson? | Maybe<Scalars[‘JSON’][‘output’]> | (Optional) 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? | Maybe<CurrencyCode | `${CurrencyCode}`> | (Optional) The settlement currency. | |
| settlementCurrencyRate? | Maybe<Scalars[‘Decimal’][‘output’]> | (Optional) The rate used when converting the transaction amount to settlement currency. | |
| shopifyPaymentsSet? | Maybe<ShopifyPaymentsTransactionSet> | (Optional) Contains all Shopify Payments information related to an order transaction. This field is available only to stores on a Shopify Plus plan. | |
| status | OrderTransactionStatus | `${OrderTransactionStatus}` | The status of this transaction. | |
| test | Scalars[‘Boolean’][‘output’] | Whether the transaction is a test transaction. | |
| totalUnsettled? | Maybe<Scalars[‘Money’][‘output’]> | (Optional) Specifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid. | |
| totalUnsettledSet? | Maybe<MoneyBag> | (Optional) 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? | Maybe<MoneyV2> | (Optional) Specifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid. | |
| user? | Maybe<StaffMember> | (Optional) Staff member who was logged into the Shopify POS device when the transaction was processed. |