Skip to main content
Version: 3.x

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
}

Fields

id (ID!)

privateMetadata ([MetadataItem!]!)

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

privateMetafield (String)

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

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

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.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metadata ([MetadataItem!]!)

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

metafield (String)

A single key from public metadata.

Tip: Use GraphQL aliases to fetch multiple keys.

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

metafields (Metadata)

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

Added in Saleor 3.3.

Note: this API is currently in Feature Preview and can be subject to changes at later point.

gateway (String!)

isActive (Boolean!)

created (DateTime!)

modified (DateTime!)

token (String!)

checkout (Checkout)

order (Order)

paymentMethodType (String!)

customerIpAddress (String)

IP address of the user who created the payment.

Requires one of the following permissions: MANAGE_ORDERS.

chargeStatus (PaymentChargeStatusEnum!)

Internal payment status.

actions ([OrderAction!]!)

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

Requires one of the following permissions: MANAGE_ORDERS.

total (Money)

Total amount of the payment.

capturedAmount (Money)

Total amount captured for this payment.

transactions ([Transaction!])

List of all transactions within this payment.

Requires one of the following permissions: MANAGE_ORDERS.

availableCaptureAmount (Money)

Maximum amount of money that can be captured.

Requires one of the following permissions: MANAGE_ORDERS.

availableRefundAmount (Money)

Maximum amount of money that can be refunded.

Requires one of the following permissions: MANAGE_ORDERS.

creditCard (CreditCard)

The details of the card used for this payment.

Interfaces

Node

An object with an ID

ObjectWithMetadata