customerPaymentMethodCreateFromDuplicationData

mutation

Requires write_customers access scope. Also: Requires write_vaulted_payment_method_duplication scope.

Creates a vaulted payment method for a customer from duplication data.

This data must be obtained from another shop within the same organization.

Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps.

Anchor to Arguments

Arguments

Anchor to billingAddressbillingAddress

•MailingAddressInput!

required

The billing address.

Anchor to customerIdcustomerId

•ID!

required

The ID of the customer.

Anchor to encryptedDuplicationDataencryptedDuplicationData

•String!

required

The encrypted payment method data.

Was this section helpful?

Anchor to CustomerPaymentMethodCreateFromDuplicationDataPayload returnsCustomerPaymentMethodCreateFromDuplicationDataPayload returns

Anchor to customerPaymentMethodcustomerPaymentMethod •CustomerPaymentMethod: The customer payment method.
Anchor to userErrorsuserErrors •[CustomerPaymentMethodCreateFromDuplicationDataUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerPaymentMethodCreateFromDuplicationData reference

Mutation Reference

mutation customerPaymentMethodCreateFromDuplicationData($billingAddress: MailingAddressInput!, $customerId: ID!, $encryptedDuplicationData: String!) {

customerPaymentMethodCreateFromDuplicationData(billingAddress: $billingAddress, customerId: $customerId, encryptedDuplicationData: $encryptedDuplicationData) {

customerPaymentMethod {

# CustomerPaymentMethod fields

}

userErrors {

field

message

}

Input

{

"billingAddress": {

"address1": "<your-address1>",

"address2": "<your-address2>",

"city": "<your-city>",

"company": "<your-company>",

"countryCode": "AC",

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

"phone": "<your-phone>",

"provinceCode": "<your-provinceCode>",

"zip": "<your-zip>"

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

"encryptedDuplicationData": "<your-encryptedDuplicationData>"

}

Variables

{
  "billingAddress": {
    "address1": "<your-address1>",
    "address2": "<your-address2>",
    "city": "<your-city>",
    "company": "<your-company>",
    "countryCode": "AC",
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "phone": "<your-phone>",
    "provinceCode": "<your-provinceCode>",
    "zip": "<your-zip>"
  },
  "customerId": "gid://shopify/<objectName>/10079785100",
  "encryptedDuplicationData": "<your-encryptedDuplicationData>"
}

Schema

input MailingAddressInput {
  address1: String
  address2: String
  city: String
  company: String
  countryCode: CountryCode
  firstName: String
  lastName: String
  phone: String
  provinceCode: String
  zip: String
}