Anchor to PaymentScheduleCapturePayloadPayment
payloadPayment
Return type for mutation.
Anchor to FieldsFields
- job (Job)
- jobResult (OrderCreateMandatePaymentJobResult)
- paymentReferenceId (String)
- userErrors ([PaymentScheduleCaptureUserError!]!)
- •Job
The async job used for charging the payment.
Show fields
- Anchor to jobResultjob•Order
Result Create Mandate Payment Job Result The job result for tracking the status of the payment capture.
Show fields
- Anchor to paymentReferenceIdpayment•String
Reference Id The unique ID for the created payment.
- Anchor to userErrorsuser•[Payment
Errors Schedule Capture User Error!]! non-null The list of errors that occurred from executing the mutation.
Show fields
Was this section helpful?
Anchor to Mutations with this payloadMutations with this payload
- paymentScheduleCapture (PaymentScheduleCapturePayload)
- •mutation
Captures payment for a due
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
to poll for the status of the payment capture.Show payload
- Anchor to paymentScheduleIdpayment•ID!
Schedule Id required The ID of the payment schedule to capture payment for.
Arguments
Was this section helpful?