Skip to main content

Payment

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​

ID of the payment.

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

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

Payment.privateMetafield ● String scalar​

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Payment.privateMetafield.key ● String! non-null scalar​

Payment.privateMetafields ● Metadata scalar​

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

Added in Saleor 3.3
Payment.privateMetafields.keys ● [String!] list scalar​

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

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

Payment.metafield ● String scalar​

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3
Payment.metafield.key ● String! non-null scalar​

Payment.metafields ● Metadata scalar​

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

Added in Saleor 3.3
Payment.metafields.keys ● [String!] list scalar​

Payment.gateway ● String! non-null scalar​

Payment gateway used for payment.

Payment.isActive ● Boolean! non-null scalar​

Determines if the payment is active or not.

Payment.created ● DateTime! non-null scalar​

Date and time at which payment was created.

Payment.modified ● DateTime! non-null scalar​

Date and time at which payment was modified.

Payment.token ● String! non-null scalar​

Unique token associated with a payment.

Payment.checkout ● Checkout object​

Checkout associated with a payment.

Payment.order ● Order object​

Order associated with a payment.

Payment.paymentMethodType ● String! non-null scalar​

Type of method used for payment.

Payment.customerIpAddress ● String scalar​

IP address of the user who created the payment.

Requires MANAGE_ORDERSpermission.

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.

Requires MANAGE_ORDERSpermission.

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.

Requires MANAGE_ORDERSpermission.

Payment.availableCaptureAmount ● Money object​

Maximum amount of money that can be captured.

Requires MANAGE_ORDERSpermission.

Payment.availableRefundAmount ● Money object​

Maximum amount of money that can be refunded.

Requires MANAGE_ORDERSpermission.

Payment.creditCard ● CreditCard object​

The details of the card used for this payment.

Payment.partial ● Boolean! non-null scalar​

Informs whether this is a partial payment.

Added in Saleor 3.14

Payment.pspReference ● String scalar​

PSP reference of the payment.

Added in Saleor 3.14

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

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