Skip to content

Commit 946b773

Browse files
ct-sdks[bot]ct-sdks[bot]
committed
Updated API from documentation release
1 parent 0745b0c commit 946b773

9 files changed

Lines changed: 92 additions & 0 deletions

‎api-specs/api/examples/Payment/PaymentSetTransactionInterfaceIdAction.json‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"action": "setTransactionInterfaceId",
3+
"transactionId": "{{transactionId}}",
4+
"interfaceId": "{{interfaceId}}"
5+
}

‎api-specs/api/types/me/MyTransactionDraft.raml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,3 +25,6 @@ properties:
2525
type: CustomFieldsDraft
2626
description: |
2727
Custom Fields of the Transaction.
28+
interfaceId?:
29+
type: string
30+
description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.

‎api-specs/api/types/message/PaymentTransactionInterfaceIdSetMessage.raml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: Message
4+
displayName: PaymentTransactionInterfaceIdSetMessage
5+
discriminatorValue: PaymentTransactionInterfaceIdSet
6+
description: |
7+
Generated after a successful [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
8+
properties:
9+
transactionId:
10+
type: string
11+
description: |
12+
Unique identifier of the [Transaction](ctp:api:type:Transaction).
13+
newInterfaceId?:
14+
type: string
15+
description: |
16+
Identifier used by the payment service that processes the Payment (for example, a PSP) after [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
17+
oldInterfaceId?:
18+
type: string
19+
description: |
20+
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.

‎api-specs/api/types/message/payload/PaymentTransactionInterfaceIdSetMessagePayload.raml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
#%RAML 1.0 DataType
2+
(package): Message
3+
type: MessagePayload
4+
displayName: PaymentTransactionInterfaceIdSetMessagePayload
5+
discriminatorValue: PaymentTransactionInterfaceIdSet
6+
description: |
7+
Generated after a successful [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
8+
properties:
9+
transactionId:
10+
type: string
11+
description: |
12+
Unique identifier of the [Transaction](ctp:api:type:Transaction).
13+
newInterfaceId?:
14+
type: string
15+
description: |
16+
Identifier used by the payment service that processes the Payment (for example, a PSP) after [Set Transaction InterfaceId](ctp:api:type:PaymentSetTransactionInterfaceIdAction) update action.
17+
oldInterfaceId?:
18+
type: string
19+
description: |
20+
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.

‎api-specs/api/types/payment/Transaction.raml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,3 +29,6 @@ properties:
2929
custom?:
3030
type: CustomFields
3131
description: Custom Fields defined for the Transaction.
32+
interfaceId?:
33+
type: string
34+
description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.

‎api-specs/api/types/payment/TransactionDraft.raml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,3 +26,6 @@ properties:
2626
custom?:
2727
type: CustomFieldsDraft
2828
description: Custom Fields of the Transaction.
29+
interfaceId?:
30+
type: string
31+
description: Identifier used by the payment service that processes the Payment (for example, a PSP) in the current transaction.

‎api-specs/api/types/payment/updates/PaymentSetTransactionInterfaceIdAction.raml‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#%RAML 1.0 DataType
2+
(package): Payment
3+
type: PaymentUpdateAction
4+
displayName: PaymentSetTransactionInterfaceIdAction
5+
discriminatorValue: setTransactionInterfaceId
6+
example: !include ../../../examples/Payment/PaymentSetTransactionInterfaceIdAction.json
7+
description: |
8+
Setting the transaction interface ID produces the [PaymentTransactionInterfaceIdSet](ctp:api:type:PaymentTransactionInterfaceIdSetMessage) Message.
9+
properties:
10+
transactionId:
11+
type: string
12+
description: |
13+
Unique identifier of the [Transaction](ctp:api:type:Transaction).
14+
interfaceId?:
15+
type: string
16+
description: |
17+
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.
18+
If `interfaceId` is absent, this field will be removed from the specified Transaction, if it exists.

‎api-specs/api/types/types.raml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1099,6 +1099,7 @@ PaymentMethodPaymentMethodStatusSetMessage: !include message/PaymentMethodPaymen
10991099
PaymentStatusInterfaceCodeSetMessage: !include message/PaymentStatusInterfaceCodeSetMessage.raml
11001100
PaymentStatusStateTransitionMessage: !include message/PaymentStatusStateTransitionMessage.raml
11011101
PaymentTransactionAddedMessage: !include message/PaymentTransactionAddedMessage.raml
1102+
PaymentTransactionInterfaceIdSetMessage: !include message/PaymentTransactionInterfaceIdSetMessage.raml
11021103
PaymentTransactionStateChangedMessage: !include message/PaymentTransactionStateChangedMessage.raml
11031104
ProductAddedToCategoryMessage: !include message/ProductAddedToCategoryMessage.raml
11041105
ProductCreatedMessage: !include message/ProductCreatedMessage.raml
@@ -1437,6 +1438,8 @@ PaymentMethodPaymentMethodStatusSetMessagePayload: !include message/payload/Paym
14371438
PaymentStatusInterfaceCodeSetMessagePayload: !include message/payload/PaymentStatusInterfaceCodeSetMessagePayload.raml
14381439
PaymentStatusStateTransitionMessagePayload: !include message/payload/PaymentStatusStateTransitionMessagePayload.raml
14391440
PaymentTransactionAddedMessagePayload: !include message/payload/PaymentTransactionAddedMessagePayload.raml
1441+
# yamllint disable-line rule:line-length
1442+
PaymentTransactionInterfaceIdSetMessagePayload: !include message/payload/PaymentTransactionInterfaceIdSetMessagePayload.raml
14401443
PaymentTransactionStateChangedMessagePayload: !include message/payload/PaymentTransactionStateChangedMessagePayload.raml
14411444
ProductAddedToCategoryMessagePayload: !include message/payload/ProductAddedToCategoryMessagePayload.raml
14421445
ProductCreatedMessagePayload: !include message/payload/ProductCreatedMessagePayload.raml
@@ -1875,6 +1878,7 @@ PaymentSetStatusInterfaceCodeAction: !include payment/updates/PaymentSetStatusIn
18751878
PaymentSetStatusInterfaceTextAction: !include payment/updates/PaymentSetStatusInterfaceTextAction.raml
18761879
PaymentSetTransactionCustomFieldAction: !include payment/updates/PaymentSetTransactionCustomFieldAction.raml
18771880
PaymentSetTransactionCustomTypeAction: !include payment/updates/PaymentSetTransactionCustomTypeAction.raml
1881+
PaymentSetTransactionInterfaceIdAction: !include payment/updates/PaymentSetTransactionInterfaceIdAction.raml
18781882
PaymentTransitionStateAction: !include payment/updates/PaymentTransitionStateAction.raml
18791883
ProductDiscount: !include product-discount/ProductDiscount.raml
18801884
ProductDiscountDraft: !include product-discount/ProductDiscountDraft.raml

‎api-specs/graphql/schema.sdl‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7264,6 +7264,7 @@ input MyTransactionDraft {
72647264
amount: MoneyInput!
72657265
interactionId: String
72667266
custom: CustomFieldsDraft
7267+
interfaceId: String
72677268
}
72687269

72697270
type NestedAttributeDefinitionType implements AttributeDefinitionType {
@@ -8316,6 +8317,13 @@ type PaymentTransactionAdded implements MessagePayload {
83168317
type: String!
83178318
}
83188319

8320+
type PaymentTransactionInterfaceIdSet implements MessagePayload {
8321+
transactionId: String!
8322+
newInterfaceId: String
8323+
oldInterfaceId: String
8324+
type: String!
8325+
}
8326+
83198327
type PaymentTransactionStateChanged implements MessagePayload {
83208328
transactionId: String!
83218329
state: TransactionState!
@@ -8361,6 +8369,7 @@ input PaymentUpdateAction {
83618369
setStatusInterfaceText: SetPaymentStatusInterfaceText
83628370
setTransactionCustomField: SetPaymentTransactionCustomField
83638371
setTransactionCustomType: SetPaymentTransactionCustomType
8372+
setTransactionInterfaceId: SetPaymentTransactionInterfaceId
83648373
transitionState: TransitionPaymentState
83658374
}
83668375

@@ -13130,6 +13139,11 @@ input SetPaymentTransactionCustomType {
1313013139
transactionId: String!
1313113140
}
1313213141

13142+
input SetPaymentTransactionInterfaceId {
13143+
transactionId: String!
13144+
interfaceId: String
13145+
}
13146+
1313313147
input SetProductAssetCustomField {
1313413148
variantId: Int
1313513149
sku: String
@@ -16088,6 +16102,7 @@ type Transaction {
1608816102
interactionId: String
1608916103
state: TransactionState!
1609016104
custom: CustomFieldsType
16105+
interfaceId: String
1609116106
}
1609216107

1609316108
input TransactionDraft {
@@ -16097,6 +16112,7 @@ input TransactionDraft {
1609716112
interactionId: String
1609816113
state: TransactionState
1609916114
custom: CustomFieldsDraft
16115+
interfaceId: String
1610016116
}
1610116117

1610216118
enum TransactionState {

0 commit comments

Comments
 (0)