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!
  chargeStatus: PaymentChargeStatusEnum!
  total: Money
  capturedAmount: Money
  creditCard: CreditCard
}

Fields​

Payment.id ● ID! non-null scalar​

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
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.
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
This API is currently in Feature Preview and can be subject to changes at later point.
Payment.metafields.keys ● [String!] list scalar​

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.order ● Order object​

Payment.paymentMethodType ● String! non-null scalar​

Payment.chargeStatus ● PaymentChargeStatusEnum! non-null enum​

Internal payment status.

Payment.total ● Money object​

Total amount of the payment.

Payment.capturedAmount ● Money object​

Total amount captured for this payment.

Payment.creditCard ● CreditCard object​

The details of the card used for this payment.

Interfaces​

Node interface​

An object with an ID

ObjectWithMetadata interface​

Member of​

CheckoutPaymentCreate object ● Order object

Was this page helpful?