Skip to main content

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
added: Date
}

Fields

NameTypeDescription
originString!Payment method origin. Valid values include "cash", "card", "stripe", "paypal", "cheque", "bankTransfer", or "creditNote".
amountFloat!Payment or refund amount in the shop's currency.
refIDOptional reference ID for the payment method (e.g., transaction ID, payment reference).
addedDateDate when the payment was added. Defaults to the current date if not specified.