Payment

Represents a payment of a given type.

type Payment implements Node, ObjectWithMetadata {
  id: ID!
  gateway: String!
  isActive: Boolean!
  created: DateTime!
  modified: DateTime!
  token: String!
  checkout: Checkout
  nauticalOrder: NauticalOrder
  paymentMethodType: String!
  paymentMethodToken: String
  customerIpAddress: String
  privateMetadata: [MetadataItem!]!
  metadata: [MetadataItem!]!
  chargeStatus: PaymentChargeStatusEnum!
  actions: [OrderAction!]!
  total: Money
  capturedAmount: Money
  transactions: [Transaction!]
  availableCaptureAmount: Money
  availableRefundAmount: Money
  creditCard: CreditCard
}

Show more ↓

Fields

Payment.id ● ID! non-null scalar

The ID of the object

Payment.gateway ● String! non-null scalar

Payment.isActive ● Boolean! non-null scalar

Payment.created ● DateTime! non-null scalar

Payment.modified ● DateTime! non-null scalar

Payment.token ● String! non-null scalar

Payment.checkout ● Checkout object

Payment.nauticalOrder ● NauticalOrder object

Payment.paymentMethodType ● String! non-null scalar

Payment.paymentMethodToken ● String scalar

Payment.customerIpAddress ● String scalar

Payment.privateMetadata ● [MetadataItem!]! non-null object

List of private metadata items.Requires proper staff permissions to access.

Payment.metadata ● [MetadataItem!]! non-null object

List of public metadata items. Can be accessed without permissions.

Payment.chargeStatus ● PaymentChargeStatusEnum! non-null enum

Internal payment status.

Payment.actions ● [OrderAction!]! non-null enum

List of actions that can be performed in the current state of a payment.

Payment.total ● Money object

Total amount of the payment.

Payment.capturedAmount ● Money object

Total amount captured for this payment.

Payment.transactions ● [Transaction!] list object

List of all transactions within this payment.

Payment.availableCaptureAmount ● Money object

Maximum amount of money that can be captured.

Payment.availableRefundAmount ● Money object

Maximum amount of money that can be refunded.

Payment.creditCard ● CreditCard object

The details of the card used for this payment.

Interfaces

Node interface

An object with an ID

ObjectWithMetadata interface

Returned By

payment query

Member Of

CheckoutPaymentCreate object ● JournalEntry object ● NauticalOrder object ● NauticalOrderPaymentCreate object ● PaymentCapture object ● PaymentCountableEdge object ● PaymentVoid object ● Transaction object