ShopifyPayment

interface

import { ShopifyPayment } from '@daffodil/driver/shopify'

A payment applied to a checkout.

interface ShopifyPayment {
  __typename: "Payment"
  amount: ShopifyMoneyV2
  amountV2: ShopifyMoneyV2
  billingAddress: ShopifyMailingAddress
  checkout: ShopifyCheckout
  creditCard: ShopifyCreditCard
  errorMessage: string
  id: string
  idempotencyKey: string
  nextActionUrl: Maybe<Scalars['URL']['output']>
  ready: boolean
  test: boolean
  transaction: ShopifyTransaction
}

Properties

__typename `"Payment"`

amount `ShopifyMoneyV2`
The amount of the payment.

amountV2 `ShopifyMoneyV2`
The amount of the payment.

billingAddress `ShopifyMailingAddress`
The billing address for the payment.

checkout `ShopifyCheckout`
The checkout to which the payment belongs.

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

errorMessage `string`
A message describing a processing error during asynchronous processing.

id `string`
A globally-unique ID.

idempotencyKey `string`
A client-side generated token to identify a payment and perform idempotent operations. For more information, refer to Idempotent requests.

nextActionUrl `Maybe<Scalars['URL']['output']>`
The URL where the customer needs to be redirected so they can complete the 3D Secure payment flow.

ready `boolean`
Whether the payment is still processing asynchronously.

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

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