---
title: PaymentsAppConfiguration - Payments Apps API
description: >-
  The [production
  configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps)

  of the payments app.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentsAppConfiguration
  md: >-
    https://shopify.dev/docs/api/payments-apps/latest/objects/PaymentsAppConfiguration.md
api_name: payments-apps
api_type: graphql
type: object
---

# Payments​App​Configuration

object

Requires `read_payment_gateways` access scope.

The [production configuration](https://shopify.dev/apps/payments/onboarding-a-merchant-payments-apps) of the payments app.

## Fields

* external​Handle

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

  A username or identifier associated with the account that the merchant has used with the partner. It displays in the Payments section in the Shopify admin. The `externalHandle` enables the merchant to identify the connected payment provider account.

* ready

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

  non-null

  Whether the provider is ready to process the merchant's payments.

***

## Map

No referencing types

***

## Mutations

* [payments​App​Configure](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure)

  mutation

  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).

  * external​Handle

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

    ### Arguments

    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.

  ***

***

## PaymentsAppConfiguration Mutations

### Mutated by

* [payments​App​Configure](https://shopify.dev/docs/api/payments-apps/latest/mutations/paymentsAppConfigure)