Payment
object

Choose a version:

Requires unauthenticated_read_checkouts access scope.

A payment applied to a checkout.

Fields

Anchor to Payment.amount amount MoneyV2! non-null: The amount of the payment.
Anchor to Payment.billingAddress billingAddress MailingAddress: The billing address for the payment.
Anchor to Payment.checkout checkout Checkout! non-null: The checkout to which the payment belongs.
Anchor to Payment.creditCard creditCard CreditCard: The credit card used for the payment in the case of direct payments.
Anchor to Payment.errorMessage errorMessage String: A message describing a processing error during asynchronous processing.
Anchor to Payment.id id ID! non-null: A globally-unique ID.
Anchor to Payment.idempotencyKey idempotencyKey String: A client-side generated token to identify a payment and perform idempotent operations. For more information, refer to Idempotent requests.
Anchor to Payment.nextActionUrl nextActionUrl URL: The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.
Anchor to Payment.ready ready Boolean! non-null: Whether the payment is still processing asynchronously.
Anchor to Payment.test test Boolean! non-null: A flag to indicate if the payment is to be done in test mode for gateways that support it.
Anchor to Payment.transaction transaction Transaction: The actual transaction recorded by Shopify after having processed the payment with the gateway.