Payment Object

Represents a payment of a given type.

type Payment implements Node, ObjectWithMetadata {
  id: ID!
  privateMetadata: [MetadataItem!]!
  privateMetafield(
    key: String!
  ): String
  privateMetafields(
    keys: [String!]
  ): Metadata
  metadata: [MetadataItem!]!
  metafield(
    key: String!
  ): String
  metafields(
    keys: [String!]
  ): Metadata
  gateway: String!
  isActive: Boolean!
  created: DateTime!
  modified: DateTime!
  token: String!
  checkout: Checkout
  order: Order
  paymentMethodType: String!
  customerIpAddress: String
  chargeStatus: PaymentChargeStatusEnum!
  actions: [OrderAction!]!
  total: Money
  capturedAmount: Money
  transactions: [Transaction!]
  availableCaptureAmount: Money
  availableRefundAmount: Money
  creditCard: CreditCard
  partial: Boolean!
  pspReference: String
}

Expand ▼

Fields

Payment.id ● ID! non-null scalar miscellaneous

ID of the payment.

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

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

Payment.privateMetafield ● String scalar miscellaneous

A single key from private metadata. Requires staff permissions to access.

Tip: Use GraphQL aliases to fetch multiple keys.

Payment.privateMetafield.key ● String! non-null scalar miscellaneous

Payment.privateMetafields ● Metadata scalar miscellaneous

Private metadata. Requires staff permissions to access. Use keys to control which fields you want to include. The default is to include everything.

Payment.privateMetafields.keys ● [String!] list scalar miscellaneous

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

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

Payment.metafield ● String scalar miscellaneous

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Payment.metafield.key ● String! non-null scalar miscellaneous

Payment.metafields ● Metadata scalar miscellaneous

Public metadata. Use keys to control which fields you want to include. The default is to include everything.

Payment.metafields.keys ● [String!] list scalar miscellaneous

Payment.gateway ● String! non-null scalar miscellaneous

Payment gateway used for payment.

Payment.isActive ● Boolean! non-null scalar miscellaneous

Determines if the payment is active or not.

Payment.created ● DateTime! non-null scalar miscellaneous

Date and time at which payment was created.

Payment.modified ● DateTime! non-null scalar miscellaneous

Date and time at which payment was modified.

Payment.token ● String! non-null scalar miscellaneous

Unique token associated with a payment.

Payment.checkout ● Checkout object checkout

Checkout associated with a payment.

Payment.order ● Order object orders

Order associated with a payment.

Payment.paymentMethodType ● String! non-null scalar miscellaneous

Type of method used for payment.

Payment.customerIpAddress ● String scalar miscellaneous

IP address of the user who created the payment.

Requires MANAGE_ORDERSpermission.

Payment.chargeStatus ● PaymentChargeStatusEnum! non-null enum payments

Internal payment status.

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

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

Requires MANAGE_ORDERSpermission.

Payment.total ● Money object miscellaneous

Total amount of the payment.

Payment.capturedAmount ● Money object miscellaneous

Total amount captured for this payment.

Payment.transactions ● [Transaction!] list object payments

List of all transactions within this payment.

Requires MANAGE_ORDERSpermission.

Payment.availableCaptureAmount ● Money object miscellaneous

Maximum amount of money that can be captured.

Requires MANAGE_ORDERSpermission.

Payment.availableRefundAmount ● Money object miscellaneous

Maximum amount of money that can be refunded.

Requires MANAGE_ORDERSpermission.

Payment.creditCard ● CreditCard object payments

The details of the card used for this payment.

Payment.partial ● Boolean! non-null scalar miscellaneous

Informs whether this is a partial payment.

Payment.pspReference ● String scalar miscellaneous

PSP reference of the payment.

Interfaces

Node interface miscellaneous

An object with an ID

ObjectWithMetadata interface miscellaneous

Returned By

payment query

Member Of

CheckoutPaymentCreate object ● Order object ● PaymentAuthorize object ● PaymentCapture object ● PaymentCaptureEvent object ● PaymentConfirmEvent object ● PaymentCountableEdge object ● PaymentProcessEvent object ● PaymentRefund object ● PaymentRefundEvent object ● PaymentVoid object ● PaymentVoidEvent object ● Transaction object