customerPaymentMethodRemoteCreate
mutation

Choose a version:

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 disableAddressValidation disableAddressValidation Boolean default:false: Disables the requirement for a billing address on the remote payment method.
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?

Code examples for MUTATION: customerPaymentMethodRemoteCreate

Query Reference for MUTATION: customerPaymentMethodRemoteCreate

"mutation customerPaymentMethodRemoteCreate($customerId: ID!, $remoteReference: CustomerPaymentMethodRemoteInput!) {\n  customerPaymentMethodRemoteCreate(customerId: $customerId, remoteReference: $remoteReference) {\n    customerPaymentMethod {\n      # CustomerPaymentMethod fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerPaymentMethodRemoteCreate

"{\n  \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n  \"disableAddressValidation\": true,\n  \"remoteReference\": {\n    \"authorizeNetCustomerPaymentProfile\": {\n      \"customerPaymentProfileId\": \"<your-customerPaymentProfileId>\",\n      \"customerProfileId\": \"<your-customerProfileId>\"\n    },\n    \"braintreePaymentMethod\": {\n      \"customerId\": \"<your-customerId>\",\n      \"paymentMethodToken\": \"<your-paymentMethodToken>\"\n    },\n    \"paypalPaymentMethod\": {\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      \"billingAgreementId\": \"<your-billingAgreementId>\"\n    },\n    \"stripePaymentMethod\": {\n      \"customerId\": \"<your-customerId>\",\n      \"paymentMethodId\": \"<your-paymentMethodId>\"\n    }\n  }\n}"

Schema Reference for MUTATION: customerPaymentMethodRemoteCreate

"input CustomerPaymentMethodRemoteInput {\n  authorizeNetCustomerPaymentProfile: RemoteAuthorizeNetCustomerPaymentProfileInput\n  braintreePaymentMethod: RemoteBraintreePaymentMethodInput\n  paypalPaymentMethod: RemotePaypalPaymentMethodInput\n  stripePaymentMethod: RemoteStripePaymentMethodInput\n}\n\ninput RemoteAuthorizeNetCustomerPaymentProfileInput {\n  customerPaymentProfileId: String\n  customerProfileId: String!\n}\n\ninput RemoteBraintreePaymentMethodInput {\n  customerId: String!\n  paymentMethodToken: String\n}\n\ninput RemotePaypalPaymentMethodInput {\n  billingAddress: MailingAddressInput!\n  billingAgreementId: String!\n}\n\ninput RemoteStripePaymentMethodInput {\n  customerId: String!\n  paymentMethodId: String\n}\n"

Display Examples for MUTATION: customerPaymentMethodRemoteCreate

[]

customerPaymentMethodRemoteCreatemutation

Arguments

CustomerPaymentMethodRemoteCreatePayload returns

customerPaymentMethodRemoteCreate
mutation