checkoutCompleteWithTokenizedPaymentV3 mutation

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.


Arguments

checkoutId ( ID! ) required

The ID of the checkout.

payment ( TokenizedPaymentInputV3! ) required

The info to apply as a tokenized payment.

TokenizedPaymentInputV3 fields

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.

paymentAmount (MoneyInput!) Required

The amount and currency of the payment.

paymentData (String!) Required

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

test (Boolean)

Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to false.

type (PaymentTokenType!) 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 executing the mutation.

payment (Payment)

A representation of the attempted payment.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use checkoutUserErrors instead

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.


Arguments

checkoutId ( ID! ) required

The ID of the checkout.

payment ( TokenizedPaymentInputV3! ) required

The info to apply as a tokenized payment.

TokenizedPaymentInputV3 fields

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.

paymentAmount (MoneyInput!) Required

The amount and currency of the payment.

paymentData (String!) Required

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

test (Boolean)

Whether to execute the payment in test mode, if possible. Test mode is not supported in production stores. Defaults to false.

type (PaymentTokenType!) 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 executing the mutation.

payment (Payment)

A representation of the attempted payment.

Deprecated return fields

userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use checkoutUserErrors instead