refundSessionReject mutation

Rejects an open refund 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 refundSessionReject($id: ID!, $reason: RefundSessionRejectionReasonInput!) { refundSessionReject(id: $id, reason: $reason) { 
  1. <font style="color:#1F61A0;">refundSession</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;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <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-unstable)

) REQUIRED		 The refund session ID.
reason
(
[RefundSessionRejectionReasonInput!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundsessionrejectionreasoninput)

) REQUIRED		 The rejection reason.

RefundSessionRejectionReasonInput fields

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

Return fields

  • refundSession ([RefundSession](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundsession))
    The updated refund session.
  • userErrors ([[RefundSessionRejectUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/orders/refundsessionrejectusererror))
    List of errors that occurred executing the mutation.