Skip to main content

paymentGatewayInitialize Mutation

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. There is a limit of 100 transaction items per checkout / order.

paymentGatewayInitialize(
  amount: PositiveDecimal
  id: ID!
  paymentGateways: [PaymentGatewayToInitialize!]
): PaymentGatewayInitialize
Show return type

Arguments​

amount ● PositiveDecimal​

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

id ● ID!​

The ID of the checkout or order.

paymentGateways ● [PaymentGatewayToInitialize!]​

List of payment gateways to initialize.

Type​

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. There is a limit of 100 transaction items per checkout / order.