paymentSessionReject mutation

Rejects an open payment session.

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.

mutation paymentSessionReject($id: ID!, $reason: PaymentSessionRejectionReasonInput!) { paymentSessionReject(id: $id, reason: $reason) { 
  1. <font style="color:#1F61A0;">paymentSession</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">field</font>
  11.   <font style="color:#1F61A0;">message</font>
  13. <font style="color:#555555;">}</font>
} } { “id”: “Z2lkOi8vU2hvcGlmeS9FeGFtcGxlLzE=”, “reason”: { 
  1. <font style="color:#8B2BB9;">"code"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
id
(
[ID!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#id-2021-01)

) REQUIRED		 The payment session ID.
reason
(
[PaymentSessionRejectionReasonInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/paymentsessionrejectionreasoninput)

) REQUIRED		 The rejection reason.

PaymentSessionRejectionReasonInput fields

  • code ([PaymentSessionStatusReasonRejectionCode!](https://shopify.dev/docs/admin-api/graphql/reference/orders/paymentsessionstatusreasonrejectioncode)) REQUIRED
    The reason code.
  • merchantMessage ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
    A custom, localized message for the merchant.

Return fields

  • paymentSession ([PaymentSession](https://shopify.dev/docs/admin-api/graphql/reference/orders/paymentsession))
    The updated payment session.
  • userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
    List of errors that occurred executing the mutation.