customerPaymentMethodCreditCardCreate mutation

Version unstable

Creates a credit card payment method for a customer.

Required access

write_customers access scope. Also: Requires write_customer_payment_methods scope.

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Argument Description
billingAddress ( MailingAddressInput! ) required

The billing address.

customerId ( ID! ) required

The ID of the customer.

sessionId ( String! ) required

The Cardserver session ID.

MailingAddressInput fields

  • address1 (String)

    The first line of the address. Typically the street address or PO Box number.

  • address2 (String)

    The second line of the address. Typically the number of the apartment, suite, or unit.

  • city (String)

    The name of the city, district, village, or town.

  • company (String)

    The name of the customer's company or organization.

  • country (String)

    The name of the country. This argument is deprecated: Use countryCode instead.

  • countryCode (CountryCode)

    The two-letter code for the country of the address.

  • firstName (String)

    The first name of the customer.

  • id (ID)

    This argument is deprecated: Not needed for 90% of mutations, and provided separately where it is needed.

  • lastName (String)

    The last name of the customer.

  • phone (String)

    A unique phone number for the customer.

    Formatted using E.164 standard. For example, +16135551111.

  • province (String)

    The region of the address, such as the province, state, or district. This argument is deprecated: Use provinceCode instead.