Added 'interfaceId' field to Transaction | HTTP API | commercetools Composable Commerce

Added 'interfaceId' field to Transaction

18 September 2025

Composable Commerce

HTTP API

Enhancement

PaymentsGraphQL

We've added the interfaceId field to Transaction. This field stores the reference provided by a Payment Service Provider (PSP) for specific payment operations, like authorization, capture, or refund. These references are sometimes required for subsequent operations, for example, when partially refunding a payment that was captured in multiple steps, you may need to specify which capture to refund.

In addition, we've added the SetTransactionInterfaceId update action to the Payments API.

Changes:

[API] Added the interfaceId field to Transaction, TransactionDraft, and MyTransactionDraft.
[API] Added the setTransactionInterfaceId update action to the Payment resource.
[API] Added the PaymentTransactionInterfaceIdSetMessage message.
[GraphQL API] Added the setTransactionInterfaceId update action to the PaymentUpdateAction input type.
[GraphQL API] Added the PaymentTransactionInterfaceIdSet message payload type.
[GraphQL API] Added the SetPaymentTransactionInterfaceId input type.
[GraphQL API] Added interfaceId field to Transaction, TransactionDraft, and MyTransactionDraft types.

The following changes were introduced in terms of GraphQL SDL:


extend input PaymentUpdateAction {
  setTransactionInterfaceId: SetPaymentTransactionInterfaceId
}

type PaymentTransactionInterfaceIdSet implements MessagePayload {
  transactionId: String!
  newInterfaceId: String
  oldInterfaceId: String
  type: String!
}

input SetPaymentTransactionInterfaceId {
  transactionId: String!
  interfaceId: String
}

extend input TransactionDraft {
  interfaceId: String
}

extend input MyTransactionDraft {
  interfaceId: String
}

extend type Transaction {
  interfaceId: String
}