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.
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.
Anchor to maximumRefundableSetmaximumRefundableSet • MoneyBag: Specifies the available amount to refund on the gateway in shop and presentment currencies. Only available within SuggestedRefund.
Anchor to parentTransactionparentTransaction • OrderTransaction: The associated parent transaction, for example the authorization of a capture.
Anchor to paymentDetailspaymentDetails • PaymentDetails: The associated payment details related to the transaction.

Show

deprecated fields Deprecated

Anchor to amountamount • Money!non-nullDeprecated: The amount of the transaction. Use amountSet instead.
Anchor to maximumRefundablemaximumRefundable • MoneyDeprecated: Specifies the available amount to refund on the gateway. Only available within SuggestedRefund. Use maximumRefundableSet instead.

Was this section helpful?