PaymentsAppConfiguration object

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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

The production configuration of the payments app.

Required access

read_payment_gateways access scope.

On this page

Fields

  • externalHandle (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!)

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