Skip to main content
Anchor to SuggestedOrderTransaction

SuggestedOrderTransaction

object

Requires read_orders access scope or read_marketplace_orders access scope.

A suggested transaction. Suggested transaction are usually used in the context of refunds and exchanges.

Anchor to FieldsFields

Anchor to accountNumberaccountNumber
•String

The masked account number associated with the payment method.

Anchor to amountSetamountSet
•MoneyBag!
non-null

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

Show fields
Anchor to formattedGatewayformattedGateway
•String

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

Anchor to gatewaygateway
•String

The suggested payment gateway used to process the transaction.

Anchor to kindkind
•SuggestedOrderTransactionKind!
non-null

Specifies the kind of the suggested order transaction.

Show enum values
Anchor to maximumRefundableSetmaximumRefundableSet
•MoneyBag

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

Show fields
Anchor to parentTransactionparentTransaction
•OrderTransaction

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

Show fields
Anchor to paymentDetailspaymentDetails
•PaymentDetails

The associated payment details related to the transaction.

Show union types
Anchor to supportedRefundTypesupportedRefundType
•TransactionSupportedRefundType!
non-null

The types of refunds that the transaction supports. For example, if it's a CARD_PRESENT_REFUND type, then the transaction requires chip data from reading a physical card using a card reader to be refunded. Only available within SuggestedRefund.

Show enum values

Deprecated fields

Anchor to amountamount
•Money!
non-nullDeprecated
Anchor to maximumRefundablemaximumRefundable
•Money
Deprecated
Was this section helpful?