order
Requires access scope. Also: The user must have permission. The API client must be installed on a Shopify Plus store to use the amount field.
Creates a payment for an Order using a stored . A payment mandate represents the customer's authorization to charge their payment method for deferred payments, such as pre-orders or try-before-you-buy purchases.
The mutation processes the payment asynchronously and returns a Job for tracking the payment status. You can specify the payment amount to collect, and use the argument to either immediately capture the payment or only authorize it for later capture. Each payment request requires a unique to prevent duplicate charges. Subsequent calls with the same key return the original payment result rather than creating a new payment.
Learn more about deferred payments and payment mandates and idempotent requests.
Arguments
- Anchor to amountamount•Money
Input The payment amount to collect.
- Anchor to autoCaptureauto•Boolean
Capture Default:true Whether the payment should be authorized or captured. If
false, then the authorization of the payment is triggered.- •ID!required
The ID of the order to collect the balance for.
- Anchor to idempotencyKeyidempotency•String!
Key required A unique key to identify the payment request.
- Anchor to mandateIdmandate•ID!
Id required The mandate ID used for payment.
- Anchor to paymentScheduleIdpayment•ID
Schedule Id The ID of the payment schedule to collect the balance for.
- •Job
The async job used for charging the payment.
- Anchor to paymentReferenceIdpayment•String
Reference Id The Unique ID for the created payment.
- Anchor to userErrorsuser•[Order
Errors Create Mandate Payment User Error!]! non-null The list of errors that occurred from executing the mutation.