checkoutCompleteWithTokenizedPayment mutation

Deprecation warning

Use checkoutCompleteWithTokenizedPaymentV2 instead

This field requires a feature not available to all merchants

Completes a checkout with a tokenized payment.

Required access

unauthenticated_write_checkouts access 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
checkoutId ( ID! ) required

The ID of the checkout.

payment ( TokenizedPaymentInput! ) required

The info to apply as a tokenized payment.

TokenizedPaymentInput 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. For more information, refer to Idempotent requests.

  • 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.

Return fields

  • checkout (Checkout!)

    The checkout on which the payment was applied.

  • checkoutUserErrors ([CheckoutUserError!]!)

    List of errors that occurred from executing the mutation.

  • payment (Payment)

    A representation of the attempted payment.