Skip to main content
Version: 3.x

checkoutComplete

Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.

checkoutComplete(
checkoutId: ID
id: ID
metadata: [MetadataInput!]
paymentData: JSONString
redirectUrl: String
storeSource: Boolean = false
token: UUID
): CheckoutComplete

Arguments

checkoutId (ID)

The ID of the checkout.

DEPRECATED: this field will be removed in Saleor 4.0. Use id instead.

id (ID)

The checkout's ID.

Added in Saleor 3.4.

metadata ([MetadataInput!])

Fields required to update the checkout metadata.

Added in Saleor 3.8.

paymentData (JSONString)

Client-side generated data required to finalize the payment.

redirectUrl (String)

URL of a view where users should be redirected to see the order details. URL in RFC 1808 format.

storeSource (Boolean)

Determines whether to store the payment source for future usage.

DEPRECATED: this field will be removed in Saleor 4.0. Use checkoutPaymentCreate for this action.

token (UUID)

Checkout token.

DEPRECATED: this field will be removed in Saleor 4.0. Use id instead.

Type

CheckoutComplete

Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.