Payment

Required access

unauthenticated_read_checkouts access scope

A payment applied to a checkout.

Show definition
# A payment applied to a checkout.
type Payment implements Node {
  # Globally unique identifier.
  id: ID!

  # The amount of the payment.
  amount: Money!

  # The billing address for the payment.
  billingAddress: MailingAddress

  # The checkout to which the payment belongs.
  checkout: Checkout!

  # The credit card used for the payment in the case of direct payments.
  creditCard: CreditCard

  # An message describing a processing error during asynchronous processing.
  errorMessage: String

  # A client-side generated token to identify a payment and perform idempotent operations.
  idempotencyKey: String

  # Whether or not the payment is still processing asynchronously.
  ready: Boolean!

  # A flag to indicate if the payment is to be done in test mode for gateways that support it.
  test: Boolean!

  # The actual transaction recorded by Shopify after having processed the payment with the gateway.
  transaction: Transaction
}

Implements

Fields

amount   (Money!)

The amount of the payment.

Required access

unauthenticated_read_ access scope

billingAddress   (MailingAddress)

The billing address for the payment.

Required access

unauthenticated_read_ access scope

checkout   (Checkout!)

The checkout to which the payment belongs.

Required access

unauthenticated_read_ access scope

creditCard   (CreditCard)

The credit card used for the payment in the case of direct payments.

Required access

unauthenticated_read_ access scope

errorMessage   (String)

An message describing a processing error during asynchronous processing.

Required access

unauthenticated_read_ access scope

id   (ID!)

Globally unique identifier.

Required access

unauthenticated_read_ access scope

idempotencyKey   (String)

A client-side generated token to identify a payment and perform idempotent operations.

Required access

unauthenticated_read_ access scope

ready   (Boolean!)

Whether or not the payment is still processing asynchronously.

Required access

unauthenticated_read_ access scope

test   (Boolean!)

A flag to indicate if the payment is to be done in test mode for gateways that support it.

Required access

unauthenticated_read_ access scope

transaction   (Transaction)

The actual transaction recorded by Shopify after having processed the payment with the gateway.

Required access

unauthenticated_read_ access scope

Sign up for a Partner account to get started.

Sign up