Choose a version:

orderCreateManualPayment

mutation

Requires write_orders access scope. Also: The user must have mark_orders_as_paid permission. The API client must be installed on a Shopify Plus store to use the amount field.

Create a manual payment for an order. You can only create a manual payment for an order if it isn't already fully paid.

Arguments

Anchor to amountamount •MoneyInput: The manual payment amount to be created.
Anchor to idid •ID!required: The ID of the order to create a manual payment for.
Anchor to paymentMethodNamepaymentMethodName •String: The name of the payment method used for creating the payment. If none is provided, then the default manual payment method ('Other') will be used.

Was this section helpful?

Anchor to OrderCreateManualPaymentPayload returnsOrderCreateManualPaymentPayload returns

Anchor to orderorder •Order: The order recorded a manual payment.
Anchor to userErrorsuserErrors •[OrderCreateManualPaymentOrderCreateManualPaymentError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?