transactionInitialize

Initializes a transaction session. It triggers the webhook TRANSACTION_INITIALIZE_SESSION, to the requested paymentGateways.

Added in Saleor 3.13

This API is currently in Feature Preview and can be subject to changes at later point.

transactionInitialize(
  action: TransactionFlowStrategyEnum
  amount: PositiveDecimal
  customerIpAddress: String
  id: ID!
  paymentGateway: PaymentGatewayToInitialize!
): TransactionInitialize

Arguments

transactionInitialize.action ● TransactionFlowStrategyEnum enum

The expected action called for the transaction. By default, the channel.defaultTransactionFlowStrategy will be used. The field can be used only by app that has HANDLE_PAYMENTS permission.

transactionInitialize.amount ● PositiveDecimal scalar

The amount requested for initializing the payment gateway. If not provided, the difference between checkout.total - transactions that are already processed will be send.

transactionInitialize.customerIpAddress ● String scalar

The customer's IP address. If not provided Saleor will try to determine the customer's IP address on its own. The customer's IP address will be passed to the payment app. The IP should be in ipv4 or ipv6 format. The field can be used only by an app that has HANDLE_PAYMENTS permission.

Added in Saleor 3.16

transactionInitialize.id ● ID! non-null scalar

The ID of the checkout or order.

transactionInitialize.paymentGateway ● PaymentGatewayToInitialize! non-null input

Payment gateway used to initialize the transaction.

Type

TransactionInitialize object

Initializes a transaction session. It triggers the webhook TRANSACTION_INITIALIZE_SESSION, to the requested paymentGateways.

Added in Saleor 3.13

This API is currently in Feature Preview and can be subject to changes at later point.