stack

Home > @infiniteobjects/shopify-data-manager > AdminTypes > OrderCaptureInput

AdminTypes.OrderCaptureInput interface

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

Signature:

export interface OrderCaptureInput 

Properties

Property Modifiers Type Description
amount   Scalars[‘Money’][‘input’] The amount to capture. The capture amount can’t be greater than the amount of the authorized transaction.
currency?   InputMaybe<CurrencyCode | `${CurrencyCode}`> (Optional) 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.
id   Scalars[‘ID’][‘input’] The ID of the order to capture.
parentTransactionId   Scalars[‘ID’][‘input’] The ID of the authorized transaction to capture.