Choose a version:

Anchor to customerPaymentMethodRemoteCreate

customerPaymentMethodRemoteCreate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

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.

Anchor to Arguments

Arguments

Anchor to customerIdcustomerId

•ID!

required

The ID of the customer.

Anchor to disableAddressValidationdisableAddressValidation

•Boolean

Default:false

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

Anchor to remoteReferenceremoteReference

•CustomerPaymentMethodRemoteInput!

required

Remote gateway payment method details.

Was this section helpful?

Anchor to CustomerPaymentMethodRemoteCreatePayload returnsCustomerPaymentMethodRemoteCreatePayload returns

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?

Examples

customerPaymentMethodRemoteCreate reference

Mutation Reference

mutation customerPaymentMethodRemoteCreate($customerId: ID!, $disableAddressValidation: Boolean, $remoteReference: CustomerPaymentMethodRemoteInput!) {

customerPaymentMethodRemoteCreate(customerId: $customerId, disableAddressValidation: $disableAddressValidation, remoteReference: $remoteReference) {

customerPaymentMethod {

# CustomerPaymentMethod fields

}

userErrors {

field

message

}

Input

{

"customerId": "gid://shopify/<objectName>/10079785100",

"disableAddressValidation": true,

"remoteReference": {

"adyenPaymentMethod": {

"billingAddress": {},

"shopperReference": "<your-shopperReference>",

"storedPaymentMethodId": "<your-storedPaymentMethodId>"

"authorizeNetCustomerPaymentProfile": {

"billingAddress": {},

"customerPaymentProfileId": "<your-customerPaymentProfileId>",

"customerProfileId": "<your-customerProfileId>"

"braintreePaymentMethod": {

"billingAddress": {},

"customerId": "<your-customerId>",

"paymentMethodToken": "<your-paymentMethodToken>"

"paypalPaymentMethod": {

"billingAddress": {},

"billingAgreementId": "<your-billingAgreementId>"

"stripePaymentMethod": {

"billingAddress": {},

"customerId": "<your-customerId>",

"paymentMethodId": "<your-paymentMethodId>"

}

Variables

{
  "customerId": "gid://shopify/<objectName>/10079785100",
  "disableAddressValidation": true,
  "remoteReference": {
    "adyenPaymentMethod": {
      "billingAddress": {},
      "shopperReference": "<your-shopperReference>",
      "storedPaymentMethodId": "<your-storedPaymentMethodId>"
    },
    "authorizeNetCustomerPaymentProfile": {
      "billingAddress": {},
      "customerPaymentProfileId": "<your-customerPaymentProfileId>",
      "customerProfileId": "<your-customerProfileId>"
    },
    "braintreePaymentMethod": {
      "billingAddress": {},
      "customerId": "<your-customerId>",
      "paymentMethodToken": "<your-paymentMethodToken>"
    },
    "paypalPaymentMethod": {
      "billingAddress": {},
      "billingAgreementId": "<your-billingAgreementId>"
    },
    "stripePaymentMethod": {
      "billingAddress": {},
      "customerId": "<your-customerId>",
      "paymentMethodId": "<your-paymentMethodId>"
    }
  }
}

Schema

input CustomerPaymentMethodRemoteInput {
  adyenPaymentMethod: RemoteAdyenPaymentMethodInput
  authorizeNetCustomerPaymentProfile: RemoteAuthorizeNetCustomerPaymentProfileInput
  braintreePaymentMethod: RemoteBraintreePaymentMethodInput
  paypalPaymentMethod: RemotePaypalPaymentMethodInput
  stripePaymentMethod: RemoteStripePaymentMethodInput
}

input RemoteAdyenPaymentMethodInput {
  billingAddress: MailingAddressInput
  shopperReference: String!
  storedPaymentMethodId: String!
}

input RemoteAuthorizeNetCustomerPaymentProfileInput {
  billingAddress: MailingAddressInput
  customerPaymentProfileId: String!
  customerProfileId: String!
}

input RemoteBraintreePaymentMethodInput {
  billingAddress: MailingAddressInput
  customerId: String!
  paymentMethodToken: String!
}

input RemotePaypalPaymentMethodInput {
  billingAddress: MailingAddressInput!
  billingAgreementId: String!
}

input RemoteStripePaymentMethodInput {
  billingAddress: MailingAddressInput
  customerId: String!
  paymentMethodId: String!
}