---
title: paymentsAppConfigure - Payments Apps API
description: Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension).
api_version: 2025-10
api_name: payments-apps
type: mutation
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure
  md: https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure.md
---

# payments​App​Configure

mutation

Requires `write_payment_gateways` access scope.

Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the `paymentsAppConfigure` mutation, refer to the tutorial for [onboarding merchants to payments extensions](https://shopify.dev/docs/apps/build/payments/onboard-a-merchant-payments-extension).

## Arguments

* external​Handle

  [String](https://shopify.dev/docs/api/payments-apps/latest/scalars/String)

  Handle used in the external system.

* ready

  [Boolean!](https://shopify.dev/docs/api/payments-apps/latest/scalars/Boolean)

  required

  The provider is ready to process merchant's payments.

***

## Payments​App​Configure​Payload returns

* payments​App​Configuration

  [Payments​App​Configuration](https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentsAppConfiguration)

  The production configuration of the payments app.

* user​Errors

  [\[User​Error!\]!](https://shopify.dev/docs/api/payments-apps/latest/objects/UserError)

  non-null

  The list of errors that occurred from executing the mutation.

***

## Examples

* ### paymentsAppConfigure reference

## Mutation Reference

```graphql
mutation paymentsAppConfigure($externalHandle: String, $ready: Boolean!) {
  paymentsAppConfigure(externalHandle: $externalHandle, ready: $ready) {
    paymentsAppConfiguration {
      # PaymentsAppConfiguration fields
    }
    userErrors {
      field
      message
    }
  }
}
```

## Input

```json
{
  "externalHandle": "<your-externalHandle>",
  "ready": true
}
```

##### Variables

```
{
  "externalHandle": "<your-externalHandle>",
  "ready": true
}
```