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.

Records a manual payment for an Order that isn't fully paid. Use this mutation to track payments received outside the standard checkout process, such as cash, check, bank transfer, or other offline payment methods.

You can specify the payment amount, method name, and when it was processed.

Anchor to Arguments

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.
Anchor to processedAtprocessedAt •DateTime: The date and time (ISO 8601 format) when a manual payment was processed. If you're importing transactions from an app or another platform, then you can set processedAt to a date and time in the past to match when the original transaction was created.

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?

Examples

orderCreateManualPayment reference

Mutation Reference

mutation orderCreateManualPayment($id: ID!, $amount: MoneyInput, $paymentMethodName: String, $processedAt: DateTime) {

orderCreateManualPayment(id: $id, amount: $amount, paymentMethodName: $paymentMethodName, processedAt: $processedAt) {

order {

# Order fields

}

userErrors {

field

message

}

Input

{

"id": "gid://shopify/<objectName>/10079785100",

"amount": {

"amount": "29.99",

"currencyCode": "USD"

"paymentMethodName": "<your-paymentMethodName>",

"processedAt": "2019-09-07T15:50:00Z"

}

Variables

{
  "id": "gid://shopify/<objectName>/10079785100",
  "amount": {
    "amount": "29.99",
    "currencyCode": "USD"
  },
  "paymentMethodName": "<your-paymentMethodName>",
  "processedAt": "2019-09-07T15:50:00Z"
}

Schema

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}