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

OrderTransactionInput input object

Version unstable

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2021-04 (Release candidate)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2021-01 (Latest)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2020-10

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2020-07

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2020-04

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2020-01 (Unsupported)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2019-10 (Unsupported)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2019-07 (Unsupported)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.

Version 2019-04 (Unsupported)

Specifies the information needed to create an order transaction.

Input fields

  • amount (Money!) Required

    The amount of money for this transaction.

  • gateway (String!) Required

    The payment gateway to use for this transaction.

  • kind (OrderTransactionKind!) Required

    The kind of transaction.

  • orderId (ID!) Required

    The ID of the order associated with the transaction.

  • parentId (ID)

    The ID of the optional parent transaction, for example the authorization of a capture.