API version: unstable
API version: 2021-01 Release candidate
API version: 2020-10 Latest
API version: 2020-07
API version: 2020-04
API version: 2020-01
API version: 2019-10 Unsupported
API version: 2019-07 Unsupported

OrderCaptureInput input object

Version 2021-01 (Release candidate)

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2020-10 (Latest)

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2020-07

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2020-04

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2020-01

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2019-10 (Unsupported)

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2019-07 (Unsupported)

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.

Version 2019-04 (Unsupported)

Specifies the authorized transaction to capture and the total amount to capture from it.

Input fields

amount (Money!) Required

The amount to capture.

currency (CurrencyCode)

The currency (in ISO format) that is 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 (ID!) Required

The ID of the order to capture.

parentTransactionId (ID!) Required

The ID of the authorized transaction to capture.