PaymentMethod Object

Description

Payment method used for a transaction, including amount, origin, and status.

Declaration

type PaymentMethod {
    _id: ID
    amount: Float!
    origin: String
    label: String
    charge: JSON
    added: Date
    ref: ID
    status: String
    intentId: String
}

Fields

Name	Type	Description
_id	ID	Internal database identifier.
amount	Float!	Payment amount in the shop's currency.
origin	String	Payment method origin. Valid values include "cash", "card", "stripe", "paypal", "cheque", "bankTransfer", or "creditNote".
label	String	Display label for the payment method.
charge	JSON	Payment processing details in JSON format (e.g., Stripe charge object).
added	Date	Date when the payment was added.
ref	ID	Reference ID for the payment (e.g., transaction ID, payment reference).
status	String	Status of the payment. Valid values include "pending", "completed", "failed", or "refunded".
intentId	String	Identifier of the transaction at the payment processor, as its own dashboard knows it — a Stripe payment intent (pi_…) or a Paypal capture id. Used to link straight to the payment. Paypal payments taken before August 2026 hold the Paypal order id instead, which does not resolve there.