CreditCardPaymentInput

Specifies the fields required to complete a checkout with a Shopify vaulted credit card payment.

Show definition
# Specifies the fields required to complete a checkout with
# a Shopify vaulted credit card payment.
input CreditCardPaymentInput {
  # The amount of the payment.
  amount: Money!

  # A unique client generated key used to avoid duplicate charges. When a
  # duplicate payment is found, the original is returned instead of creating a new one.
  idempotencyKey: String!

  # The billing address for the payment.
  billingAddress: MailingAddressInput!

  # The ID returned by Shopify's Card Vault.
  vaultId: String!

  # Executes the payment in test mode if possible. Defaults to `false`.
  test: Boolean = false
}

Input Fields

amount   (Money!) Required

The amount of the payment.

billingAddress   (MailingAddressInput!) Required

The billing address for the payment.

idempotencyKey   (String!) Required

A unique client generated key used to avoid duplicate charges. When a duplicate payment is found, the original is returned instead of creating a new one.

test   (Boolean)

Executes the payment in test mode if possible. Defaults to false.

vaultId   (String!) Required

The ID returned by Shopify's Card Vault.