Choose a version:

paymentScheduleCapture

mutation

Requires write_payment_mandate access scope. Also: The user must have pay_orders_by_vaulted_card permission.

Captures payment for a due PaymentSchedule using the vaulted payment method associated with the order.

The mutation resolves the order and mandate from the given payment schedule, then initiates an asynchronous payment capture. Use the returned jobResult to poll for the status of the payment capture.

Anchor to Arguments

Arguments

Anchor to paymentScheduleIdpaymentScheduleId •ID! required: The ID of the payment schedule to capture payment for.

Was this section helpful?

Anchor to PaymentScheduleCapturePayload returnsPaymentScheduleCapturePayload returns

Anchor to jobjob •Job: The async job used for charging the payment.
Anchor to jobResultjobResult •OrderCreateMandatePaymentJobResult: The job result for tracking the status of the payment capture.
Anchor to paymentReferenceIdpaymentReferenceId •String: The unique ID for the created payment.
Anchor to userErrorsuserErrors •[PaymentScheduleCaptureUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

paymentScheduleCapture reference

Mutation Reference

mutation paymentScheduleCapture($paymentScheduleId: ID!) {

paymentScheduleCapture(paymentScheduleId: $paymentScheduleId) {

job {

# Job fields

}

jobResult {

# OrderCreateMandatePaymentJobResult fields

}

paymentReferenceId

userErrors {

field

message

}

Input

{

"paymentScheduleId": "gid://shopify/<objectName>/10079785100"

}