paymentSessionPending mutation
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.
Required access
write_payment_sessions
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The payment session ID. |
pendingExpiresAt
(
DateTime!
)
required
|
The date and time when the pending payment expires, recommended to be within 3 days. |
reason
(
PaymentSessionStatePendingReason!
)
required
|
The reason the payment is pending. |
Return fields
-
paymentSession (
PaymentSession
)The updated payment session.
-
userErrors (
[PaymentSessionPendingUserError!]!
)The list of errors that occurred from executing the mutation.
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.
Required access
write_payment_sessions
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The payment session ID. |
pendingExpiresAt
(
DateTime!
)
required
|
The date and time when the pending payment expires, recommended to be within 3 days. |
reason
(
PaymentSessionStatePendingReason!
)
required
|
The reason the payment is pending. |
Return fields
-
paymentSession (
PaymentSession
)The updated payment session.
-
userErrors (
[PaymentSessionPendingUserError!]!
)The list of errors that occurred from executing the mutation.
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.
Required access
write_payment_sessions
access scope.
On this page
Interactive example
This is an example mutation query. Use the embedded interactive tool below to edit the query.
Hint: use Ctrl + Space for autocompleting fields.
Arguments
Argument | Description |
---|---|
id
(
ID!
)
required
|
The payment session ID. |
pendingExpiresAt
(
DateTime!
)
required
|
The date and time when the pending payment expires, recommended to be within 3 days. |
reason
(
PaymentSessionStatePendingReason!
)
required
|
The reason the payment is pending. |
Return fields
-
paymentSession (
PaymentSession
)The updated payment session.
-
userErrors (
[PaymentSessionPendingUserError!]!
)The list of errors that occurred from executing the mutation.