OrderTransaction

Required access

read_orders access scope

A transaction represents an exchange of money as part of an order.

Show definition
# A transaction represents an exchange of money as part of an order.
type OrderTransaction implements Node {
  # Globally unique identifier.
  id: ID!

  # The masked account number associated with the payment method.
  accountNumber: String

  # The amount of money.
  amount: Money!

  # The amount and currency of the transaction.
  amountV2: MoneyV2!

  # Authorization code associated with the transaction.
  authorizationCode: String

  # Date and time when the transaction was created.
  createdAt: DateTime!

  # A standardized error code, independent of the payment provider.
  errorCode: OrderTransactionErrorCode

  # The human-readable payment gateway name used to process the transaction.
  formattedGateway: String

  # The payment gateway used to process the transaction.
  gateway: String

  # The kind of transaction.
  kind: OrderTransactionKind!

  # Whether the transaction can be manually captured.
  manuallyCapturable: Boolean

  # Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.
  maximumRefundable: Money

  # Specifies the available amount with currency to refund on the gateway.
  # Only available within SuggestedRefund.
  maximumRefundableV2: MoneyV2

  # The associated order.
  order: Order

  # The associated parent transaction, for example the authorization of a capture.
  parentTransaction: OrderTransaction

  # Specifies the payment icon to display for this transaction.
  paymentIcon(
    # Image width in pixels between 1 and 2048. This argument is deprecated: Use `maxWidth` on `Image.transformedSrc` instead.
    maxWidth: Int

    # Image height in pixels between 1 and 2048. This argument is deprecated: Use
    # `maxHeight` on `Image.transformedSrc` instead.
    maxHeight: Int

    # Crops the image according to the specified region. This argument is
    # deprecated: Use `crop` on `Image.transformedSrc` instead.
    crop: CropRegion

    # Image size multiplier for high-resolution retina displays. Must be between 1
    # and 3. This argument is deprecated: Use `scale` on `Image.transformedSrc` instead.
    scale: Int = 1
  ): Image

  # Specifies the credit card company used to pay for this transaction.
  paymentMethod: PaymentMethods

  # A transaction receipt attached to the transaction by the gateway.
  # The value of this field depends on which gateway processed the transaction.
  receipt: String

  # The status of this transaction.
  status: OrderTransactionStatus!

  # Whether the transaction is a test transaction.
  test: Boolean!

  # Specifies the available amount to capture on the gateway.
  # Only available when an amount is capturable or manually mark as paid.
  totalUnsettled: Money

  # Specifies the available amount with currency to capture on the gateway.
  # Only available when an amount is capturable or manually mark as paid.
  totalUnsettledV2: MoneyV2
}

Implements

Fields

accountNumber   (String)

The masked account number associated with the payment method.

amountV2   (MoneyV2!)

The amount and currency of the transaction.

authorizationCode   (String)

Authorization code associated with the transaction.

createdAt   (DateTime!)

Date and time when the transaction was created.

errorCode   (OrderTransactionErrorCode)

A standardized error code, independent of the payment provider.

formattedGateway   (String)

The human-readable payment gateway name used to process the transaction.

gateway   (String)

The payment gateway used to process the transaction.

id   (ID!)

Globally unique identifier.

kind   (OrderTransactionKind!)

The kind of transaction.

manuallyCapturable   (Boolean)

Whether the transaction can be manually captured.

maximumRefundableV2   (MoneyV2)

Specifies the available amount with currency to refund on the gateway. Only available within SuggestedRefund.

order   (Order)

The associated order.

parentTransaction   (OrderTransaction)

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

paymentIcon   (Image)

Specifies the payment icon to display for this transaction.

Argument Type Default Description
crop

CropRegion

Crops the image according to the specified region. This argument is deprecated: Use crop on Image.transformedSrc instead.

maxHeight

Int

Image height in pixels between 1 and 2048. This argument is deprecated: Use maxHeight on Image.transformedSrc instead.

maxWidth

Int

Image width in pixels between 1 and 2048. This argument is deprecated: Use maxWidth on Image.transformedSrc instead.

scale

Int

1

Image size multiplier for high-resolution retina displays. Must be between 1 and 3. This argument is deprecated: Use scale on Image.transformedSrc instead.

receipt   (String)

A transaction receipt attached to the transaction by the gateway. The value of this field depends on which gateway processed the transaction.

status   (OrderTransactionStatus!)

The status of this transaction.

test   (Boolean!)

Whether the transaction is a test transaction.

totalUnsettledV2   (MoneyV2)

Specifies the available amount with currency to capture on the gateway. Only available when an amount is capturable or manually mark as paid.

Deprecated fields

Show/Hide

amount   (Money!)

deprecated

The amount of money.

Deprecation warning

Use amountV2 instead

maximumRefundable   (Money)

deprecated

Specifies the available amount to refund on the gateway. Only available within SuggestedRefund.

Deprecation warning

Use maximumRefundableV2 instead

paymentMethod   (PaymentMethods)

deprecated

Specifies the credit card company used to pay for this transaction.

Deprecation warning

Use paymentIcon instead

totalUnsettled   (Money)

deprecated

Specifies the available amount to capture on the gateway. Only available when an amount is capturable or manually mark as paid.

Deprecation warning

Use totalUnsettledV2 instead

Sign up for a Partner account to get started.

Sign up