Choose a version:

paymentSessionModal

mutation

Requires write_payment_sessions access scope.

Raises a modal that will be displayed to the buyer after a checkout is completed. Included data will be used to populate the UI extension in the modal.

Anchor to Arguments

Arguments

Anchor to actionaction

•ModalAction!

required

The buyer action and corresponding data that will be made available in the modal at runtime.

Show input fields

Anchor to expiresAtexpiresAt

•DateTime

The date and time the modal will expire, in UTC

Anchor to idid

•ID!

required

The payment session ID.

Was this section helpful?

Anchor to PaymentSessionModalPayload returnsPaymentSessionModalPayload returns

Anchor to paymentSessionpaymentSession •PaymentSession: The updated payment session.

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

Show fields

Was this section helpful?

Examples

paymentSessionModal reference

Mutation Reference

mutation paymentSessionModal($action: ModalAction!, $expiresAt: DateTime, $id: ID!) {

paymentSessionModal(action: $action, expiresAt: $expiresAt, id: $id) {

paymentSession {

# PaymentSession fields

}

userErrors {

field

message

}

Input

{

"action": {

"external": {

"data": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"

"qrCode": {

"code": "<your-code>",

"data": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"

}

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

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

}

Variables

{
  "action": {
    "external": {
      "data": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"
    },
    "qrCode": {
      "code": "<your-code>",
      "data": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"
    }
  },
  "expiresAt": "2019-09-07T15:50:00Z",
  "id": "gid://shopify/<objectName>/10079785100"
}

Schema

input ModalAction {
  external: External
  qrCode: QrCode
}

input External {
  data: JSON
}

input QrCode {
  code: String!
  data: JSON
}