Order
Requires access scope. Also: The user requires permission.
A job result for tracking the status of a mandate payment request on an order.
Anchor to FieldsFields
- done (Boolean!)
- errors ([UserError!]!)
- id (ID!)
- order (Order)
- status (OrderCreateMandatePaymentStatus!)
- Anchor to donedone•Boolean!non-null
This indicates if the job is still queued or has been run.
- Anchor to errorserrors•[User
Error!]! non-null Returns any errors that occurred during the mandate payment.
- •ID!non-null
A globally-unique ID that's returned when running an asynchronous mutation.
- Anchor to orderorder•Order
The order associated with the mandate payment request.
- Anchor to statusstatus•Order
Create Mandate Payment Status! non-null The current status of the mandate payment request.
Anchor to MutationsMutations
- orderCreateMandatePayment (OrderCreateMandatePaymentPayload)
- paymentScheduleCapture (PaymentScheduleCapturePayload)
- •mutation
Creates a payment for an
Orderusing 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
Jobfor tracking the payment status. You can specify the payment amount to collect, and use theargument to either immediately capture the payment or only authorize it for later capture. Each payment request requires a uniqueto 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.
- 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.
Arguments
- •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.- Anchor to paymentScheduleIdpayment•ID!
Schedule Id required The ID of the payment schedule to capture payment for.
Arguments