Skip to main content
Version: Canary 🚧


Event sent when user wants to initialize the payment gateway.

Added in Saleor 3.13
This API is currently in Feature Preview and can be subject to changes at later point.
type PaymentGatewayInitializeSession implements Event {
issuedAt: DateTime
version: String
issuingPrincipal: IssuingPrincipal
recipient: App
sourceObject: OrderOrCheckout!
data: JSON
amount: PositiveDecimal


PaymentGatewayInitializeSession.issuedAt ● DateTime scalar

Time of the event.

PaymentGatewayInitializeSession.version ● String scalar

Saleor version that triggered the event.

PaymentGatewayInitializeSession.issuingPrincipal ● IssuingPrincipal union

The user or application that triggered the event.

PaymentGatewayInitializeSession.recipient ● App object

The application receiving the webhook.

PaymentGatewayInitializeSession.sourceObject ● OrderOrCheckout! non-null union

Checkout or order ● JSON scalar

Payment gateway data in JSON format, received from storefront.

PaymentGatewayInitializeSession.amount ● PositiveDecimal scalar

Amount requested for initializing the payment gateway.


Event interface

Was this page helpful?