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.

Arguments

Anchor to actionaction •ModalAction! required: The buyer action and corresponding data that will be made available in the modal at runtime.
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.
Anchor to userErrorsuserErrors •[PaymentSessionModalUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

paymentSessionModal reference

Mutation Reference

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

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

paymentSession {

# PaymentSession fields

}

userErrors {

field

message

}

Input

{

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

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

"action": {

"qrCode": {

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

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

"external": {

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

}

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

input ModalAction {
  qrCode: QrCode
  external: External
}

input QrCode {
  code: String!
  data: JSON
}

input External {
  data: JSON
}