Payment Object

Represents a payment of a given type.

The legacy Payments API is deprecated and will be removed. Use the Transactions API instead.

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
  pspReference: String
}

Interfaces

Node, ObjectWithMetadata

Fields

id

id · ID!

ID of the payment.

privateMetadata

privateMetadata · [MetadataItem!]!

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

privateMetafield

privateMetafield · String

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

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

privateMetafields

privateMetafields · Metadata

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

keys

keys · [String!]

metadata

metadata · [MetadataItem!]!

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

metafield

metafield · String

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

key

key · String!

metafields

metafields · Metadata

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

keys

keys · [String!]

gateway

gateway · String!

Payment gateway used for payment.

isActive

isActive · Boolean!

Determines if the payment is active or not.

created

created · DateTime!

Date and time at which payment was created.

modified

modified · DateTime!

Date and time at which payment was modified.

token

token · String!

Unique token associated with a payment.

checkout

checkout · Checkout

Checkout associated with a payment.

order

order · Order

Order associated with a payment.

paymentMethodType

paymentMethodType · String!

Type of method used for payment.

customerIpAddress

customerIpAddress · String

IP address of the user who created the payment.

chargeStatus

chargeStatus · PaymentChargeStatusEnum!

Internal payment status.

actions

actions · [OrderAction!]!

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

total

total · Money

Total amount of the payment.

capturedAmount

capturedAmount · Money

Total amount captured for this payment.

transactions

transactions · [Transaction!]

List of all transactions within this payment.

availableCaptureAmount

availableCaptureAmount · Money

Maximum amount of money that can be captured.

availableRefundAmount

availableRefundAmount · Money

Maximum amount of money that can be refunded.

creditCard

creditCard · CreditCard

The details of the card used for this payment.

pspReference

pspReference · String

PSP reference of the payment.

Used by

• CheckoutPaymentCreate (objects)
• payment (queries)
• Order (objects)
• PaymentAuthorize (objects)
• PaymentCapture (objects)
• PaymentCaptureEvent (objects)
• PaymentConfirmEvent (objects)
• PaymentCountableEdge (objects)
• PaymentProcessEvent (objects)
• PaymentRefund (objects)
• PaymentRefundEvent (objects)
• PaymentVoid (objects)
• PaymentVoidEvent (objects)
• Transaction (objects)

Schema: Saleor 3.23.43. Download SDL.