Updated API from documentation release

ct-sdks[bot] · ct-sdks[bot] · commit 946b77339c0a · 2025-09-18T14:13:37.000Z
diff --git a/api-specs/api/examples/Payment/PaymentSetTransactionInterfaceIdAction.json b/api-specs/api/examples/Payment/PaymentSetTransactionInterfaceIdAction.json
@@ -0,0 +1,5 @@
+{
+  "action": "setTransactionInterfaceId",
+  "transactionId": "{{transactionId}}",
+  "interfaceId": "{{interfaceId}}"
+}
diff --git a/api-specs/api/types/me/MyTransactionDraft.raml b/api-specs/api/types/me/MyTransactionDraft.raml
@@ -25,3 +25,6 @@ properties:
     type: CustomFieldsDraft
     description: |
       Custom Fields of the Transaction.
+  interfaceId?:
+    type: string
+    description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.
diff --git a/api-specs/api/types/message/PaymentTransactionInterfaceIdSetMessage.raml b/api-specs/api/types/message/PaymentTransactionInterfaceIdSetMessage.raml
@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+(package): Message
+type: Message
+displayName: PaymentTransactionInterfaceIdSetMessage
+discriminatorValue: PaymentTransactionInterfaceIdSet
+description: |
+  Generated after a successful [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
+properties:
+  transactionId:
+    type: string
+    description: |
+      Unique identifier of the [Transaction](ctp:api:type:Transaction).
+  newInterfaceId?:
+    type: string
+    description: |
+      Identifier used by the payment service that processes the Payment (for example, a PSP) after [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
+  oldInterfaceId?:
+    type: string
+    description: |
+      Identifier used by the payment service that processes the Payment (for example, a PSP) before the [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
diff --git a/api-specs/api/types/message/payload/PaymentTransactionInterfaceIdSetMessagePayload.raml b/api-specs/api/types/message/payload/PaymentTransactionInterfaceIdSetMessagePayload.raml
@@ -0,0 +1,20 @@
+#%RAML 1.0 DataType
+(package): Message
+type: MessagePayload
+displayName: PaymentTransactionInterfaceIdSetMessagePayload
+discriminatorValue: PaymentTransactionInterfaceIdSet
+description: |
+  Generated after a successful [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
+properties:
+  transactionId:
+    type: string
+    description: |
+      Unique identifier of the [Transaction](ctp:api:type:Transaction).
+  newInterfaceId?:
+    type: string
+    description: |
+      Identifier used by the payment service that processes the Payment (for example, a PSP) after [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
+  oldInterfaceId?:
+    type: string
+    description: |
+      Identifier used by the payment service that processes the Payment (for example, a PSP) before the [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
diff --git a/api-specs/api/types/payment/Transaction.raml b/api-specs/api/types/payment/Transaction.raml
@@ -29,3 +29,6 @@ properties:
   custom?:
     type: CustomFields
     description: Custom Fields defined for the Transaction.
+  interfaceId?:
+    type: string
+    description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.
diff --git a/api-specs/api/types/payment/TransactionDraft.raml b/api-specs/api/types/payment/TransactionDraft.raml
@@ -26,3 +26,6 @@ properties:
   custom?:
     type: CustomFieldsDraft
     description: Custom Fields of the Transaction.
+  interfaceId?:
+    type: string
+    description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.
diff --git a/api-specs/api/types/payment/updates/PaymentSetTransactionInterfaceIdAction.raml b/api-specs/api/types/payment/updates/PaymentSetTransactionInterfaceIdAction.raml
@@ -0,0 +1,18 @@
+#%RAML 1.0 DataType
+(package): Payment
+type: PaymentUpdateAction
+displayName: PaymentSetTransactionInterfaceIdAction
+discriminatorValue: setTransactionInterfaceId
+example: !include ../../../examples/Payment/PaymentSetTransactionInterfaceIdAction.json
+description: |
+  Setting the transaction interface ID produces the [PaymentTransactionInterfaceIdSet](ctp:api:type:PaymentTransactionInterfaceIdSetMessage) Message.
+properties:
+  transactionId:
+    type: string
+    description: |
+      Unique identifier of the [Transaction](ctp:api:type:Transaction).
+  interfaceId?:
+    type: string
+    description: |
+      Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction. It must be unique across all transactions.
+      If `interfaceId` is absent, this field will be removed from the specified Transaction, if it exists.
diff --git a/api-specs/api/types/types.raml b/api-specs/api/types/types.raml
@@ -1099,6 +1099,7 @@ PaymentMethodPaymentMethodStatusSetMessage: !include message/PaymentMethodPaymen
 PaymentStatusInterfaceCodeSetMessage: !include message/PaymentStatusInterfaceCodeSetMessage.raml
 PaymentStatusStateTransitionMessage: !include message/PaymentStatusStateTransitionMessage.raml
 PaymentTransactionAddedMessage: !include message/PaymentTransactionAddedMessage.raml
+PaymentTransactionInterfaceIdSetMessage: !include message/PaymentTransactionInterfaceIdSetMessage.raml
 PaymentTransactionStateChangedMessage: !include message/PaymentTransactionStateChangedMessage.raml
 ProductAddedToCategoryMessage: !include message/ProductAddedToCategoryMessage.raml
 ProductCreatedMessage: !include message/ProductCreatedMessage.raml
@@ -1437,6 +1438,8 @@ PaymentMethodPaymentMethodStatusSetMessagePayload: !include message/payload/Paym
 PaymentStatusInterfaceCodeSetMessagePayload: !include message/payload/PaymentStatusInterfaceCodeSetMessagePayload.raml
 PaymentStatusStateTransitionMessagePayload: !include message/payload/PaymentStatusStateTransitionMessagePayload.raml
 PaymentTransactionAddedMessagePayload: !include message/payload/PaymentTransactionAddedMessagePayload.raml
+# yamllint disable-line rule:line-length
+PaymentTransactionInterfaceIdSetMessagePayload: !include message/payload/PaymentTransactionInterfaceIdSetMessagePayload.raml
 PaymentTransactionStateChangedMessagePayload: !include message/payload/PaymentTransactionStateChangedMessagePayload.raml
 ProductAddedToCategoryMessagePayload: !include message/payload/ProductAddedToCategoryMessagePayload.raml
 ProductCreatedMessagePayload: !include message/payload/ProductCreatedMessagePayload.raml
@@ -1875,6 +1878,7 @@ PaymentSetStatusInterfaceCodeAction: !include payment/updates/PaymentSetStatusIn
 PaymentSetStatusInterfaceTextAction: !include payment/updates/PaymentSetStatusInterfaceTextAction.raml
 PaymentSetTransactionCustomFieldAction: !include payment/updates/PaymentSetTransactionCustomFieldAction.raml
 PaymentSetTransactionCustomTypeAction: !include payment/updates/PaymentSetTransactionCustomTypeAction.raml
+PaymentSetTransactionInterfaceIdAction: !include payment/updates/PaymentSetTransactionInterfaceIdAction.raml
 PaymentTransitionStateAction: !include payment/updates/PaymentTransitionStateAction.raml
 ProductDiscount: !include product-discount/ProductDiscount.raml
 ProductDiscountDraft: !include product-discount/ProductDiscountDraft.raml
diff --git a/api-specs/graphql/schema.sdl b/api-specs/graphql/schema.sdl
@@ -7264,6 +7264,7 @@ input MyTransactionDraft {
   amount: MoneyInput!
   interactionId: String
   custom: CustomFieldsDraft
+  interfaceId: String
 }
 
 type NestedAttributeDefinitionType implements AttributeDefinitionType {
@@ -8316,6 +8317,13 @@ type PaymentTransactionAdded implements MessagePayload {
   type: String!
 }
 
+type PaymentTransactionInterfaceIdSet implements MessagePayload {
+  transactionId: String!
+  newInterfaceId: String
+  oldInterfaceId: String
+  type: String!
+}
+
 type PaymentTransactionStateChanged implements MessagePayload {
   transactionId: String!
   state: TransactionState!
@@ -8361,6 +8369,7 @@ input PaymentUpdateAction {
   setStatusInterfaceText: SetPaymentStatusInterfaceText
   setTransactionCustomField: SetPaymentTransactionCustomField
   setTransactionCustomType: SetPaymentTransactionCustomType
+  setTransactionInterfaceId: SetPaymentTransactionInterfaceId
   transitionState: TransitionPaymentState
 }
 
@@ -13130,6 +13139,11 @@ input SetPaymentTransactionCustomType {
   transactionId: String!
 }
 
+input SetPaymentTransactionInterfaceId {
+  transactionId: String!
+  interfaceId: String
+}
+
 input SetProductAssetCustomField {
   variantId: Int
   sku: String
@@ -16088,6 +16102,7 @@ type Transaction {
   interactionId: String
   state: TransactionState!
   custom: CustomFieldsType
+  interfaceId: String
 }
 
 input TransactionDraft {
@@ -16097,6 +16112,7 @@ input TransactionDraft {
   interactionId: String
   state: TransactionState
   custom: CustomFieldsDraft
+  interfaceId: String
 }
 
 enum TransactionState {
