Skip to main content

paymentInitialize Mutation

DEPRECATED

The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.

Initializes payment process when it is required by gateway.

paymentInitialize(
  channel: String
  gateway: String!
  paymentData: JSONString
): PaymentInitialize @deprecated
Details
type PaymentInitialize {
  initializedPayment: PaymentInitialized
  paymentErrors: [PaymentError!]! @deprecated
  errors: [PaymentError!]!
}

Arguments​

channel ● String​

Slug of a channel for which the data should be returned.

gateway ● String!​

A gateway name used to initialize the payment.

paymentData ● JSONString​

Client-side generated data required to initialize the payment.

Type​

PaymentInitialize​

Initializes payment process when it is required by gateway.