Choose a version:

paymentSessionPending

mutation

Requires write_payment_sessions access scope.

Change a payment session status to pending.

Upon receiving the response from the PaymentSessionPending mutation, you must redirect the customer back to Shopify, using redirectUrl in nextAction.

Upon completion, pending payments must be finalized into either a successful or failed state using the paymentSessionResolve or paymentSessionReject mutations. Both sale and authorization payments can be marked as pending.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The payment session ID.
Anchor to pendingExpiresAtpendingExpiresAt •DateTime! required: The date and time when the pending payment expires, recommended to be within 3 days.
Anchor to reasonreason •PaymentSessionStatePendingReason! required: The reason the payment is pending.

Was this section helpful?

Anchor to PaymentSessionPendingPayload returnsPaymentSessionPendingPayload returns

Anchor to paymentSessionpaymentSession •PaymentSession: The updated payment session.
Anchor to userErrorsuserErrors •[PaymentSessionPendingUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

paymentSessionPending reference

Mutation Reference

mutation paymentSessionPending($id: ID!, $pendingExpiresAt: DateTime!, $reason: PaymentSessionStatePendingReason!) {

paymentSessionPending(id: $id, pendingExpiresAt: $pendingExpiresAt, reason: $reason) {

paymentSession {

# PaymentSession fields

}

userErrors {

field

message

}

Input

{

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

"pendingExpiresAt": "2019-09-07T15:50:00Z",

"reason": "BUYER_ACTION_REQUIRED"

}