customerPaymentMethodCreditCardCreate
mutation

Choose a version:

Requires write_customers access scope. Also: Requires write_customer_payment_methods scope.

Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.

Anchor to section titled 'Arguments'

Arguments

Anchor to billingAddress billingAddress MailingAddressInput! required: The billing address.
Anchor to customerId customerId ID! required: The ID of the customer.
Anchor to sessionId sessionId String! required: The Cardserver session ID. Obtained by storing card data with Shopify's Cardsink. Exchanging raw card data for a session ID must be done in a PCI complaint environment.

Was this section helpful?

Anchor to section titled 'CustomerPaymentMethodCreditCardCreatePayload returns'

CustomerPaymentMethodCreditCardCreatePayload returns

Anchor to CustomerPaymentMethodCreditCardCreatePayload.customerPaymentMethod customerPaymentMethod CustomerPaymentMethod: The customer payment method.
Anchor to CustomerPaymentMethodCreditCardCreatePayload.processing processing Boolean: If the card verification result is processing. When this is true, customer_payment_method will be null.
Anchor to CustomerPaymentMethodCreditCardCreatePayload.userErrors userErrors [UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: customerPaymentMethodCreditCardCreate

Query Reference for MUTATION: customerPaymentMethodCreditCardCreate

"mutation customerPaymentMethodCreditCardCreate($billingAddress: MailingAddressInput!, $customerId: ID!, $sessionId: String!) {\n  customerPaymentMethodCreditCardCreate(billingAddress: $billingAddress, customerId: $customerId, sessionId: $sessionId) {\n    customerPaymentMethod {\n      # CustomerPaymentMethod fields\n    }\n    processing\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerPaymentMethodCreditCardCreate

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

Schema Reference for MUTATION: customerPaymentMethodCreditCardCreate

"input MailingAddressInput {\n  address1: String\n  address2: String\n  city: String\n  company: String\n  country: String\n  countryCode: CountryCode\n  firstName: String\n  id: ID\n  lastName: String\n  phone: String\n  province: String\n  provinceCode: String\n  zip: String\n}\n"

Display Examples for MUTATION: customerPaymentMethodCreditCardCreate

[]

customerPaymentMethodCreditCardCreatemutation

Arguments

CustomerPaymentMethodCreditCardCreatePayload returns

customerPaymentMethodCreditCardCreate
mutation