Skip to main content
Anchor to OrderCreateMandatePaymentPayload

OrderCreateMandatePaymentPayload

payload

Return type for orderCreateMandatePayment mutation.

•Job

The async job used for charging the payment.

•String

The Unique ID for the created payment.

•[OrderCreateMandatePaymentUserError!]!
non-null

The list of errors that occurred from executing the mutation.


Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

Creates a payment for an Order using a stored PaymentMandate. 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 autoCapture argument to either immediately capture the payment or only authorize it for later capture. Each payment request requires a unique idempotencyKey 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.


Was this section helpful?