paymentsAppConfigure mutation

Configure the partner managed gateway onto the merchant’s store.

Required access

write_payment_gateways access scope.

On this page

• Interactive example
• Arguments
• Return fields

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.

<font style="color:#1F61A0;">paymentsAppConfiguration</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">externalHandle</font>
  <font style="color:#1F61A0;">ready</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

Return fields

• paymentsAppConfiguration ([PaymentsAppConfiguration](https://shopify.dev/docs/admin-api/graphql/reference/orders/paymentsappconfiguration))
  The production configuration of the payments app.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.