We're constantly trying to improve your support experience, and your feedback is extremely valuable to us.

Please take a moment to tell us about your experience today.
Sign up for future Help Center user research studies.

OrderTransactionInput

Version 2019-04

Specifies the information needed to create an order transaction.

Show definition
"""
Specifies the information needed to create an order transaction.
"""
input OrderTransactionInput {
  """
  The amount of money for this transaction.
  """
  amount: Money!
  """
  The payment gateway to use for this transaction.
  """
  gateway: String!
  """
  The kind of transaction.
  """
  kind: OrderTransactionKind!
  """
  The ID of the order associated with the transaction.
  """
  orderId: ID!
  """
  The ID of the optional parent transaction, for example the authorization of a capture.
  """
  parentId: ID
}

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 (Latest)

Specifies the information needed to create an order transaction.

Show definition
"""
Specifies the information needed to create an order transaction.
"""
input OrderTransactionInput {
  """
  The amount of money for this transaction.
  """
  amount: Money!
  """
  The payment gateway to use for this transaction.
  """
  gateway: String!
  """
  The kind of transaction.
  """
  kind: OrderTransactionKind!
  """
  The ID of the order associated with the transaction.
  """
  orderId: ID!
  """
  The ID of the optional parent transaction, for example the authorization of a capture.
  """
  parentId: ID
}

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 (Release candidate)

Specifies the information needed to create an order transaction.

Show definition
"""
Specifies the information needed to create an order transaction.
"""
input OrderTransactionInput {
  """
  The amount of money for this transaction.
  """
  amount: Money!
  """
  The payment gateway to use for this transaction.
  """
  gateway: String!
  """
  The kind of transaction.
  """
  kind: OrderTransactionKind!
  """
  The ID of the order associated with the transaction.
  """
  orderId: ID!
  """
  The ID of the optional parent transaction, for example the authorization of a capture.
  """
  parentId: ID
}

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.

Sign up for a Partner account to get started.

Sign up