Skip to main content

TransactionUpdateInput

No description

input TransactionUpdateInput {
status: String
type: String
name: String
message: String
reference: String
pspReference: String
availableActions: [TransactionActionEnum!]
amountAuthorized: MoneyInput
amountCharged: MoneyInput
amountRefunded: MoneyInput
amountVoided: MoneyInput
amountCanceled: MoneyInput
metadata: [MetadataInput!]
privateMetadata: [MetadataInput!]
externalUrl: String
}

Fields

TransactionUpdateInput.status ● String scalar

Status of the transaction.

DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). The status is not needed. The amounts can be used to define the current status of transactions.

TransactionUpdateInput.type ● String scalar

Payment type used for this transaction.

DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use name and message instead.

TransactionUpdateInput.name ● String scalar

Payment name of the transaction.

Added in Saleor 3.13

TransactionUpdateInput.message ● String scalar

The message of the transaction.

Added in Saleor 3.13

TransactionUpdateInput.reference ● String scalar

Reference of the transaction.

DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use pspReference instead.

TransactionUpdateInput.pspReference ● String scalar

PSP Reference of the transaction.

Added in Saleor 3.13

TransactionUpdateInput.availableActions ● [TransactionActionEnum!] list enum

List of all possible actions for the transaction

TransactionUpdateInput.amountAuthorized ● MoneyInput input

Amount authorized by this transaction.

TransactionUpdateInput.amountCharged ● MoneyInput input

Amount charged by this transaction.

TransactionUpdateInput.amountRefunded ● MoneyInput input

Amount refunded by this transaction.

TransactionUpdateInput.amountVoided ● MoneyInput input

Amount voided by this transaction.

DEPRECATED: this field will be removed in Saleor 3.15 (Preview Feature). Use amountCanceled instead.

TransactionUpdateInput.amountCanceled ● MoneyInput input

Amount canceled by this transaction.

Added in Saleor 3.13

TransactionUpdateInput.metadata ● [MetadataInput!] list input

Payment public metadata.

TransactionUpdateInput.privateMetadata ● [MetadataInput!] list input

Payment private metadata.

TransactionUpdateInput.externalUrl ● String scalar

The url that will allow to redirect user to payment provider page with transaction event details.

Added in Saleor 3.13

Member of

transactionUpdate mutation


Was this page helpful?