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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the 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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the 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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the 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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the 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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the 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 Onboard a merchant payments app tutorial.

Required access

write_payment_gateways access scope.

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.


Arguments

Argument Description
externalHandle ( String )

Handle used in the external system.

ready ( Boolean! ) required

The provider is ready to process merchant's payments.

Return fields

  • paymentsAppConfiguration (PaymentsAppConfiguration)

    The production configuration of the payments app.

  • userErrors ([UserError!]!)

    The list of errors that occurred from executing the mutation.