Skip to main content
Anchor to CustomerPaymentMethodRemoteUserError

CustomerPaymentMethodRemoteUserError

object

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

An error in the input of a mutation. Mutations return UserError objects to indicate validation failures, such as invalid field values or business logic violations, that prevent the operation from completing.

•CustomerPaymentMethodRemoteUserErrorCode

The error code.

•[String!]

The path to the input field that caused the error.

•String!
non-null

The error message.


Was this section helpful?

•mutation

Creates a customer payment method using identifiers from remote payment gateways like Stripe, Authorize.Net, or Braintree. Imports existing payment methods from external gateways and associates them with Customer objects in Shopify.

The operation processes payment methods asynchronously. The returned CustomerPaymentMethod initially has incomplete details while Shopify validates and processes the remote gateway information. Use the customerPaymentMethod query to retrieve the payment method status until all details are available or the payment method is revoked.

Learn more about migrating customer payment methods from remote gateways.

Arguments

•ID!
required

The ID of the customer.

•CustomerPaymentMethodRemoteInput!
required

Remote gateway payment method details.

Anchor to disableAddressValidationdisableAddressValidation
•Boolean
Default:false

Disables the requirement for a billing address on the remote payment method.



Was this section helpful?


Was this section helpful?