SuggestedOrderTransaction object

This page was printed on Dec 06, 2019. For the current version, visit https://help.shopify.com/en/api/graphql-admin-api/reference/object/order/suggestedordertransaction.
Version 2020-01 (Release candidate)

Represents a suggested transaction.

Required access

read_orders access scope

Fields

accountNumber (String)

The masked account number associated with the payment method.
amountSet (MoneyBag!)

The amount on the order transaction in applicable currencies.
formattedGateway (String)

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

The payment gateway used to process the transaction.
kind (SuggestedOrderTransactionKind!)

Specifies the kind of the suggested order transaction.
maximumRefundableSet (MoneyBag)

Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
parentTransaction (OrderTransaction)

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

Types that return SuggestedOrderTransaction

Deprecated fields

Show/Hide
amount (Money!) deprecated

The amount of the transaction.

Deprecation warning

Use amountSet instead
maximumRefundable (Money) deprecated

Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.

Deprecation warning

Use maximumRefundableSet instead
Version 2019-10 (Latest)

Represents a suggested transaction.

Required access

read_orders access scope

Fields

accountNumber (String)

The masked account number associated with the payment method.
amountSet (MoneyBag!)

The amount on the order transaction in applicable currencies.
formattedGateway (String)

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

The payment gateway used to process the transaction.
kind (SuggestedOrderTransactionKind!)

Specifies the kind of the suggested order transaction.
maximumRefundableSet (MoneyBag)

Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
parentTransaction (OrderTransaction)

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

Types that return SuggestedOrderTransaction

Deprecated fields

Show/Hide
amount (Money!) deprecated

The amount of the transaction.

Deprecation warning

Use amountSet instead
maximumRefundable (Money) deprecated

Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.

Deprecation warning

Use maximumRefundableSet instead
Version 2019-07

Represents a suggested transaction.

Required access

read_orders access scope

Fields

accountNumber (String)

The masked account number associated with the payment method.
amountSet (MoneyBag!)

The amount on the order transaction in applicable currencies.
formattedGateway (String)

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

The payment gateway used to process the transaction.
kind (SuggestedOrderTransactionKind!)

Specifies the kind of the suggested order transaction.
maximumRefundableSet (MoneyBag)

Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
parentTransaction (OrderTransaction)

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

Types that return SuggestedOrderTransaction

Deprecated fields

Show/Hide
amount (Money!) deprecated

The amount of the transaction.

Deprecation warning

Use amountSet instead
maximumRefundable (Money) deprecated

Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.

Deprecation warning

Use maximumRefundableSet instead
Version 2019-04

Represents a suggested transaction.

Required access

read_orders access scope

Fields

accountNumber (String)

The masked account number associated with the payment method.
amountSet (MoneyBag!)

The amount on the order transaction in applicable currencies.
formattedGateway (String)

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

The payment gateway used to process the transaction.
kind (SuggestedOrderTransactionKind!)

Specifies the kind of the suggested order transaction.
maximumRefundableSet (MoneyBag)

Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
parentTransaction (OrderTransaction)

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

Types that return SuggestedOrderTransaction

Deprecated fields

Show/Hide
amount (Money!) deprecated

The amount of the transaction.

Deprecation warning

Use amountSet instead
maximumRefundable (Money) deprecated

Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.

Deprecation warning

Use maximumRefundableSet instead

Sign up for a Partner account to get started.

Sign up