OrderPaymentMethodInput Input

Description

Input fields for adding a payment or refund method to an order. The origin specifies the payment method type, and the amount is the payment or refund value.

Declaration

input OrderPaymentMethodInput {
    origin: String!
    amount: Float!
    ref: ID
    intentId: String
    added: Date
}

Fields

Name	Type	Description
origin	String!	Payment method origin. Valid values include "cash", "card", "stripe", "paypal", "cheque", "bankTransfer", or "creditNote".
amount	Float!	Payment or refund amount in the shop's currency.
ref	ID	Reference to another document the payment draws on — currently the credit note being spent. Not a processor reference; use intentId for that.
intentId	String	Identifier of the transaction at the payment processor, for a payment recorded by hand: a Stripe payment intent (pi_…) or a Paypal capture id. Links the payment method through to the processor's own dashboard, the same way an automatic one does.
added	Date	Date when the payment was added. Defaults to the current date if not specified.