TokenizedPaymentInput

Specifies the fields required to complete a checkout with a tokenized payment.

Show definition
# Specifies the fields required to complete a checkout with
# a tokenized payment.
input TokenizedPaymentInput {
  # 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 type of payment token.
  type: String!

  # A simple string or JSON containing the required payment data for the tokenized payment.
  paymentData: String!

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

  # Public Hash Key used for AndroidPay payments only.
  identifier: String
}

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.

identifier   (String)

Public Hash Key used for AndroidPay payments only.

paymentData   (String!) Required

A simple string or JSON containing the required payment data for the tokenized payment.

test   (Boolean)

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

type   (String!) Required

The type of payment token.