Choose a version:

paymentSessionConfirm

mutation

Requires write_payment_sessions access scope.

Initiates the confirmation process of the given payment_session.

Shopify will start confirming the payment. According to its business logic, Shopify determines if the payment can be authorized and sends a POST request to the payments app, delivering the confirmation result.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The payment session ID.

Was this section helpful?

Anchor to PaymentSessionConfirmPayload returnsPaymentSessionConfirmPayload returns

Anchor to paymentSessionpaymentSession •PaymentSession: The updated payment session.

Show fields
Anchor to userErrorsuserErrors •[PaymentSessionConfirmUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

paymentSessionConfirm reference

Mutation Reference

mutation paymentSessionConfirm($id: ID!) {

paymentSessionConfirm(id: $id) {

paymentSession {

# PaymentSession fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100"

}