Choose a version:

customerPaymentMethodRemoteCreate

mutation

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

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 disableAddressValidationdisableAddressValidation • BooleanDefault: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?

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": {

"authorizeNetCustomerPaymentProfile": {

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

"customerProfileId": "<your-customerProfileId>"

"braintreePaymentMethod": {

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

"paymentMethodToken": "<your-paymentMethodToken>"

"paypalPaymentMethod": {

"billingAddress": "",

"billingAgreementId": "<your-billingAgreementId>"

"stripePaymentMethod": {

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

"paymentMethodId": "<your-paymentMethodId>"

}

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

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

input RemoteAuthorizeNetCustomerPaymentProfileInput {
  customerPaymentProfileId: String
  customerProfileId: String!
}

input RemoteBraintreePaymentMethodInput {
  customerId: String!
  paymentMethodToken: String
}

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

input RemoteStripePaymentMethodInput {
  customerId: String!
  paymentMethodId: String
}