Updated API from documentation release

commercetools · Jan 31, 2025 · bfbd178 · bfbd178
1 parent 5076237
commit bfbd178
Show file tree

Hide file tree

Showing 8 changed files with 30 additions and 10 deletions.
diff --git a/api-specs/checkout/examples/payments/cancelPaymentAction.json b/api-specs/checkout/examples/payments/cancelPaymentAction.json
@@ -1,3 +1,4 @@
 {
-  "action": "cancelPayment"
-}
+  "action": "cancelPayment",
+  "merchantReference": "example-reference"
+}
diff --git a/api-specs/checkout/examples/payments/capturePayment.json b/api-specs/checkout/examples/payments/capturePayment.json
@@ -5,7 +5,8 @@
       "amount": {
         "centAmount": 10000,
         "currencyCode": "EUR"
-      }
+      },
+      "merchantReference": "example-reference"
     }
   ]
-}
+}
diff --git a/api-specs/checkout/examples/payments/capturePaymentAction.json b/api-specs/checkout/examples/payments/capturePaymentAction.json
@@ -3,5 +3,6 @@
   "amount": {
     "centAmount": 10000,
     "currencyCode": "EUR"
-  }
-}
+  },
+  "merchantReference": "example-reference"
+}
diff --git a/api-specs/checkout/examples/payments/refundPaymentAction.json b/api-specs/checkout/examples/payments/refundPaymentAction.json
@@ -3,5 +3,6 @@
   "amount": {
     "centAmount": 10000,
     "currencyCode": "EUR"
-  }
-}
+  },
+  "merchantReference": "example-reference"
+}
diff --git a/api-specs/checkout/types/payment-intents/PaymentIntentAction.raml b/api-specs/checkout/types/payment-intents/PaymentIntentAction.raml
@@ -8,8 +8,12 @@ properties:
   action:
     type: PaymentIntentOperation
     description: |
-      Action to execute for the given Payment.
+      Action to execute for the given [Payment](/../api/projects/payments#payment).
   amount?:
     type: common.Amount
     description: |
       Amount to be captured or refunded.
+  merchantReference?:
+    type: string
+    description: |
+      A merchant-defined identifier associated with the Payment to track and reconcile the Payment Intent Action on the merchant's side. For example, an invoice number.
diff --git a/api-specs/checkout/types/payment-intents/PaymentIntentCancelAction.raml b/api-specs/checkout/types/payment-intents/PaymentIntentCancelAction.raml
@@ -13,3 +13,7 @@ description: |
 properties:
   action:
     type: string
+  merchantReference?:
+    type: string
+    description: |
+      A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
diff --git a/api-specs/checkout/types/payment-intents/PaymentIntentCaptureAction.raml b/api-specs/checkout/types/payment-intents/PaymentIntentCaptureAction.raml
@@ -15,3 +15,7 @@ properties:
     description: |
       Amount to be captured. It must be less than or equal to the [authorized](/payments-lifecycle#authorization) amount.
     type: common.Amount
+  merchantReference?:
+    type: string
+    description: |
+      A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.
diff --git a/api-specs/checkout/types/payment-intents/PaymentIntentRefundAction.raml b/api-specs/checkout/types/payment-intents/PaymentIntentRefundAction.raml
@@ -11,7 +11,11 @@ description: |
 properties:
   action:
     type: string
-  amount?:
+  amount:
     description: |
       Amount to be refunded. It must be less than or equal to the [captured](/payments-lifecycle#payment-capture) amount.
     type: common.Amount
+  merchantReference?:
+    type: string
+    description: |
+      A merchant-defined identifier associated with the [Payment](/../api/projects/payments#payment) to track and reconcile the [Payment Intent Action](ctp:checkout:type:PaymentIntentAction) on the merchant's side. For example, an invoice number.