OrderTransaction object
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
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 and is populated only for Shopify Payments authorizations.
-
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.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
receiptJson (
JSON
)The transaction receipt that is attached to the transaction by the gateway. The value of this field depends on which 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.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
OrderTransaction.node
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
Types that return OrderTransaction
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransaction
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
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 and is populated only for Shopify Payments authorizations.
-
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.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
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.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
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 and is populated only for Shopify Payments authorizations.
-
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.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
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.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.
Types that return OrderTransactionEdge
A transaction represents an exchange of money as part of an order.
Required access
read_orders
access scope.
Fields
-
accountNumber (
String
)The masked account number associated with the payment method.
-
amountSet (
MoneyBag!
)The amount and currency of the transaction in shop and presentment currencies.
-
authorizationCode (
String
)Authorization code associated with the transaction.
-
createdAt (
DateTime!
)Date and time when the transaction was created.
-
errorCode (
OrderTransactionErrorCode
)A standardized error code, independent of the payment provider.
-
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!
)Globally unique identifier.
-
kind (
OrderTransactionKind!
)The kind of transaction.
-
manuallyCapturable (
Boolean!
)Whether the transaction can be manually captured.
-
maximumRefundableV2 (
MoneyV2
)Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.
-
order (
Order
)The associated order.
-
parentTransaction (
OrderTransaction
)The associated parent transaction, for example the authorization of a capture.
-
paymentIcon (
Image
)Specifies the payment icon to display for this transaction.
Argument Description crop
(CropRegion
)Crops the image according to the specified region. This argument is deprecated: Use
crop
onImage.transformedSrc
instead.maxHeight
(Int
)Image height in pixels between 1 and 2048. This argument is deprecated: Use
maxHeight
onImage.transformedSrc
instead.maxWidth
(Int
)Image width in pixels between 1 and 2048. This argument is deprecated: Use
maxWidth
onImage.transformedSrc
instead.scale
(Int
)Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use
scale
onImage.transformedSrc
instead.
Default value:1
-
processedAt (
DateTime
)Date and time when the transaction was processed.
-
status (
OrderTransactionStatus!
)The status of this transaction.
-
test (
Boolean!
)Whether the transaction is a test transaction.
-
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.
Types that return OrderTransaction
-
Order.transactions
-
OrderTransaction.parentTransaction
-
Refund.transactions
-
SuggestedOrderTransaction.parentTransaction
Implements
Deprecated fields
-
amount (
Money!
) deprecatedThe amount of money.
Deprecation warning
Use
amountSet
instead -
amountV2 (
MoneyV2!
) deprecatedThe amount and currency of the transaction.
Deprecation warning
Use
amountSet
instead -
maximumRefundable (
Money
) deprecatedSpecifies the available amount to refund on the gateway. Only available within SuggestedRefund.
Deprecation warning
Use
maximumRefundableV2
instead -
paymentMethod (
PaymentMethods
) deprecatedSpecifies the credit card company used to pay for this transaction.
Deprecation warning
Use
paymentIcon
instead -
receipt (
String
) deprecatedA transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.
Deprecation warning
Use
receiptJson
instead -
totalUnsettled (
Money
) deprecatedSpecifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead -
totalUnsettledV2 (
MoneyV2
) deprecatedSpecifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.
Deprecation warning
Use
totalUnsettledSet
instead
An auto-generated type for paginating through multiple OrderTransactions.
On this page
Fields
-
edges (
[OrderTransactionEdge!]!
)A list of edges.
-
pageInfo (
PageInfo!
)Information to aid in pagination.
An auto-generated type which holds one OrderTransaction and a cursor during pagination.
On this page
Fields
-
cursor (
String!
)A cursor for use in pagination.
-
node (
OrderTransaction!
)The item at the end of OrderTransactionEdge.