Skip to main content
Anchor to CustomerPaymentMethodRemoteUserError

CustomerPaymentMethodRemoteUserError

object

Requires read_customers access scope. Also: Requires read_customer_payment_methods scope.

Represents an error in the input of a mutation.

Anchor to FieldsFields

Anchor to codecode
•CustomerPaymentMethodRemoteUserErrorCode

The error code.

Anchor to fieldfield
•[String!]

The path to the input field that caused the error.

Anchor to messagemessage
•String!non-null

The error message.

Was this section helpful?

Anchor to MutationsMutations

Anchor to customerPaymentMethodRemoteCreatecustomerPaymentMethodRemoteCreate
•mutation

Create a payment method from remote gateway identifiers. NOTE: This operation processes payment methods asynchronously. The returned payment method will initially have incomplete details. Developers must poll this payment method using customerPaymentMethod query until all payment method details are available, or the payment method is revoked (usually within seconds).

Arguments

Anchor to customerIdcustomerId
•ID!required

The ID of the customer.

Anchor to remoteReferenceremoteReference
•CustomerPaymentMethodRemoteInput!required

Remote gateway payment method details.

Fields

Anchor to customerPaymentMethodcustomerPaymentMethod
•CustomerPaymentMethod

The customer payment method. Note that the returned payment method may initially be in an incomplete state. Developers should poll this payment method using the customerPaymentMethod query until all required payment details have been processed.

Anchor to userErrorsuserErrors
•[CustomerPaymentMethodRemoteUserError!]!non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?

Anchor to InterfacesInterfaces

Was this section helpful?