Anchor to section titled 'undefined'

customerPaymentMethodRemoteCreate
mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Create a payment method from remote gateway identifiers.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerId
customerId
ID!
required

The ID of the customer.

Anchor to remoteReference
remoteReference
CustomerPaymentMethodRemoteInput!
required

Remote gateway payment method details.

Was this section helpful?
Anchor to section titled 'CustomerPaymentMethodRemoteCreatePayload returns'

CustomerPaymentMethodRemoteCreatePayload returns

Anchor to CustomerPaymentMethodRemoteCreatePayload.customerPaymentMethod
customerPaymentMethod
CustomerPaymentMethod

The customer payment method.

Anchor to CustomerPaymentMethodRemoteCreatePayload.userErrors
userErrors
[CustomerPaymentMethodRemoteUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerPaymentMethodRemoteCreate($customerId: ID!, $remoteReference: CustomerPaymentMethodRemoteInput!) {
  customerPaymentMethodRemoteCreate(customerId: $customerId, remoteReference: $remoteReference) {
    customerPaymentMethod {
      # CustomerPaymentMethod fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerId": "gid://shopify/<objectName>/10079785100",
  "remoteReference": {
    "authorizeNetCustomerPaymentProfile": {
      "customerPaymentProfileId": "<your-customerPaymentProfileId>",
      "customerProfileId": "<your-customerProfileId>"
    },
    "braintreePaymentMethod": {
      "customerId": "<your-customerId>",
      "paymentMethodToken": "<your-paymentMethodToken>"
    },
    "stripePaymentMethod": {
      "customerId": "<your-customerId>",
      "paymentMethodId": "<your-paymentMethodId>"
    }
  }
}
input CustomerPaymentMethodRemoteInput {
  authorizeNetCustomerPaymentProfile: RemoteAuthorizeNetCustomerPaymentProfileInput
  braintreePaymentMethod: RemoteBraintreePaymentMethodInput
  stripePaymentMethod: RemoteStripePaymentMethodInput
}

input RemoteAuthorizeNetCustomerPaymentProfileInput {
  customerPaymentProfileId: String
  customerProfileId: String!
}

input RemoteBraintreePaymentMethodInput {
  customerId: String!
  paymentMethodToken: String
}

input RemoteStripePaymentMethodInput {
  customerId: String!
  paymentMethodId: String
}