Payment

Represents a payment.

type Payment implements Node, ObjectWithMetadata {
  id: ID!
  metadata: [MetadataItem!]!
  privateMetadata: [MetadataItem!]!
  gateway: String!
  isActive: Boolean!
  created: DateTime!
  modified: DateTime!
  token: String!
  currency: String!
  billingFirstName: String!
  billingLastName: String!
  billingCompanyName: String!
  billingAddress1: String!
  billingAddress2: String!
  billingCity: String!
  billingCityArea: String!
  billingPostalCode: String!
  billingCountryCode: String!
  billingCountryArea: String!
  paymentMethodType: String!
  paymentMethodToken: String
  customerIpAddress: String
  notifiedExternal: String!
  chargeStatus: PaymentChargeStatusEnum!
  actions: [OrderAction!]!
  total: Money
  capturedAmount: Money
  availableCaptureAmount: Money
  availableRefundAmount: Money
  creditCard: CreditCard
  transactions: [Transaction!]!
  checkoutId: ID
  nauticalOrderId: ID
  checkout: ID
  nauticalOrder: ID
}

Show more ↓

Fields

Payment.id ● ID! non-null scalar

The Globally Unique ID of this object

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

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

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

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

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.currency ● String! non-null scalar

Payment.billingFirstName ● String! non-null scalar

Payment.billingLastName ● String! non-null scalar

Payment.billingCompanyName ● String! non-null scalar

Payment.billingAddress1 ● String! non-null scalar

Payment.billingAddress2 ● String! non-null scalar

Payment.billingCity ● String! non-null scalar

Payment.billingCityArea ● String! non-null scalar

Payment.billingPostalCode ● String! non-null scalar

Payment.billingCountryCode ● String! non-null scalar

Payment.billingCountryArea ● String! non-null scalar

Payment.paymentMethodType ● String! non-null scalar

Payment.paymentMethodToken ● String scalar

Payment.customerIpAddress ● String scalar

Payment.notifiedExternal ● String! non-null scalar

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.

Payment.total ● Money object

Total amount of the payment.

Payment.capturedAmount ● Money object

Total amount captured for 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.

Payment.transactions ● [Transaction!]! non-null object

List of all transactions within this payment.

Payment.checkoutId ● ID scalar

ID of the checkout this payment is for.

Payment.nauticalOrderId ● ID scalar

ID of the nautical order this payment is for.

Payment.checkout ● ID scalar

Checkout associated with this payment.

Payment.nauticalOrder ● ID scalar

Nautical order associated with this payment.

Interfaces

Node interface

An object with a Globally Unique ID

ObjectWithMetadata interface

An object that supports metadata.

Returned By

payment query

Member Of

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