Payments
Requires access scope.
The production configuration of the payments app.
Anchor to FieldsFields
- Anchor to externalHandleexternal•String
Handle 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
enables the merchant to identify the connected payment provider account.- Anchor to readyready•Boolean!non-null
Whether the provider is ready to process the merchant's payments.
Anchor to MutationsMutations
- •mutation
Configures the partner-managed payments gateway to work on the merchant's store. For an example of how to use the
mutation, refer to the tutorial for onboarding merchants to payments extensions.- Anchor to externalHandleexternal•String
Handle Handle used in the external system.
- Anchor to readyready•Boolean!required
The provider is ready to process merchant's payments.
Arguments
- Anchor to paymentsAppConfigurationpayments•Payments
App Configuration App Configuration The production configuration of the payments app.
- Anchor to userErrorsuser•[User
Errors Error!]! non-null The list of errors that occurred from executing the mutation.
Fields