orderCreateMandatePayment - admin-graphql - MUTATION

Version: 2024-10

Description:

Creates a payment for an order by mandate.

Access Scopes

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

Arguments

  • amount: MoneyInput - The payment amount to collect.
  • autoCapture: Boolean - Whether the payment should be authorized or captured. If `false`, then the authorization of the payment is triggered.
  • id: ID! - The ID of the order to collect the balance for.
  • idempotencyKey: String! - A unique key to identify the payment request.
  • mandateId: ID! - The mandate ID used for payment.
  • paymentScheduleId: ID - The ID of the payment schedule to collect the balance for.

Returns

  • job: Job The async job used for charging the payment.
  • paymentReferenceId: String The Unique ID for the created payment.
  • userErrors: OrderCreateMandatePaymentUserError! The list of errors that occurred from executing the mutation.

Examples