Anchor to section titled 'undefined'

OrderCaptureInput
input_object

The input fields for the authorized transaction to capture and the total amount to capture from it.


The amount to capture. The capture amount can't be greater than the amount of the authorized transaction.

The currency (in ISO format) that's used to capture the order. This must be the presentment currency (the currency used by the customer) and is a required field for orders where the currency and presentment currency differ.

Indicates whether this is to be the final capture for the order transaction. Only applies to Shopify Payments authorizations which are multi-capturable. If true, any uncaptured amount from the authorization will be voided after the capture is completed. If false, the authorization will remain open for future captures.

For multi-capturable authorizations, this defaults to false if not provided. This field has no effect on authorizations which aren't multi-capturable (can only be captured once), or on other types of transactions.

The ID of the order to capture.

The ID of the authorized transaction to capture.


Was this section helpful?


Was this section helpful?
Map

Fields

OrderCaptureInput

Mutations using this input