Skip to main content
Version: 3.x

paymentGatewayInitialize

Initializes a payment gateway session. It triggers the webhook PAYMENT_GATEWAY_INITIALIZE_SESSION, to the requested paymentGateways. If paymentGateways is not provided, the webhook will be send to all subscribed payment gateways.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.
paymentGatewayInitialize(
amount: PositiveDecimal
id: ID!
paymentGateways: [PaymentGatewayToInitialize!]
): PaymentGatewayInitialize

Arguments

paymentGatewayInitialize.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.

paymentGatewayInitialize.id ● ID! non-null scalar

The ID of the checkout or order.

paymentGatewayInitialize.paymentGateways ● [PaymentGatewayToInitialize!] list input

List of payment gateways to initialize.

Type

PaymentGatewayInitialize object

Initializes a payment gateway session. It triggers the webhook PAYMENT_GATEWAY_INITIALIZE_SESSION, to the requested paymentGateways. If paymentGateways is not provided, the webhook will be send to all subscribed payment gateways.

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

Was this page helpful?