chore: synced file(s) with sumup/apis (#91)

appscisumup · web-flow · commit ffe8d46fe681 · 2026-05-21T13:07:38.000+02:00
diff --git a/openapi.json b/openapi.json
@@ -7180,14 +7180,7 @@
             "example": "2020-02-29T10:56:56.876Z"
           },
           "status": {
-            "description": "Current status of the transaction.",
-            "type": "string",
-            "enum": [
-              "SUCCESSFUL",
-              "CANCELLED",
-              "FAILED",
-              "PENDING"
-            ]
+            "$ref": "#/components/schemas/TransactionStatus"
           },
           "payment_type": {
             "$ref": "#/components/schemas/PaymentType"
@@ -7650,6 +7643,18 @@
         ],
         "title": "Currency"
       },
+      "TransactionStatus": {
+        "description": "Current status of the transaction.\n\n- `PENDING`: The transaction has been created but its final outcome is not known yet.\n- `SUCCESSFUL`: The transaction completed successfully.\n- `CANCELLED`: The transaction was cancelled or otherwise reversed before completion.\n- `FAILED`: The transaction attempt did not complete successfully.\n- `REFUNDED`: The transaction was refunded in full or in part.",
+        "type": "string",
+        "enum": [
+          "SUCCESSFUL",
+          "CANCELLED",
+          "FAILED",
+          "PENDING",
+          "REFUNDED"
+        ],
+        "title": "Transaction Status"
+      },
       "EventType": {
         "description": "Type of the transaction event.",
         "type": "string",
diff --git a/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutSuccessTransactionsItem.java
@@ -32,8 +32,14 @@ public record CheckoutSuccessTransactionsItem(
     /** Payment type used for the transaction. */
     com.sumup.sdk.models.PaymentType paymentType,
 
-    /** Current status of the transaction. */
-    com.sumup.sdk.models.TransactionFullStatus status,
+    /**
+     * Current status of the transaction. - `PENDING`: The transaction has been created but its
+     * final outcome is not known yet. - `SUCCESSFUL`: The transaction completed successfully. -
+     * `CANCELLED`: The transaction was cancelled or otherwise reversed before completion. -
+     * `FAILED`: The transaction attempt did not complete successfully. - `REFUNDED`: The
+     * transaction was refunded in full or in part.
+     */
+    com.sumup.sdk.models.TransactionStatus status,
 
     /**
      * Date and time of the creation of the transaction. Response format expressed according to
@@ -70,7 +76,7 @@ public static final class Builder {
     private Long installmentsCount;
     private String merchantCode;
     private com.sumup.sdk.models.PaymentType paymentType;
-    private com.sumup.sdk.models.TransactionFullStatus status;
+    private com.sumup.sdk.models.TransactionStatus status;
     private java.time.OffsetDateTime timestamp;
     private Float tipAmount;
     private String transactionCode;
@@ -171,10 +177,14 @@ public Builder paymentType(com.sumup.sdk.models.PaymentType paymentType) {
     /**
      * Sets the value for {@code status}.
      *
-     * @param status Current status of the transaction.
+     * @param status Current status of the transaction. - `PENDING`: The transaction has been
+     *     created but its final outcome is not known yet. - `SUCCESSFUL`: The transaction completed
+     *     successfully. - `CANCELLED`: The transaction was cancelled or otherwise reversed before
+     *     completion. - `FAILED`: The transaction attempt did not complete successfully. -
+     *     `REFUNDED`: The transaction was refunded in full or in part.
      * @return This builder instance.
      */
-    public Builder status(com.sumup.sdk.models.TransactionFullStatus status) {
+    public Builder status(com.sumup.sdk.models.TransactionStatus status) {
       this.status = status;
       return this;
     }
diff --git a/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java b/src/main/java/com/sumup/sdk/models/CheckoutTransactionsItem.java
@@ -32,8 +32,14 @@ public record CheckoutTransactionsItem(
     /** Payment type used for the transaction. */
     com.sumup.sdk.models.PaymentType paymentType,
 
-    /** Current status of the transaction. */
-    com.sumup.sdk.models.TransactionFullStatus status,
+    /**
+     * Current status of the transaction. - `PENDING`: The transaction has been created but its
+     * final outcome is not known yet. - `SUCCESSFUL`: The transaction completed successfully. -
+     * `CANCELLED`: The transaction was cancelled or otherwise reversed before completion. -
+     * `FAILED`: The transaction attempt did not complete successfully. - `REFUNDED`: The
+     * transaction was refunded in full or in part.
+     */
+    com.sumup.sdk.models.TransactionStatus status,
 
     /**
      * Date and time of the creation of the transaction. Response format expressed according to
@@ -70,7 +76,7 @@ public static final class Builder {
     private Long installmentsCount;
     private String merchantCode;
     private com.sumup.sdk.models.PaymentType paymentType;
-    private com.sumup.sdk.models.TransactionFullStatus status;
+    private com.sumup.sdk.models.TransactionStatus status;
     private java.time.OffsetDateTime timestamp;
     private Float tipAmount;
     private String transactionCode;
@@ -171,10 +177,14 @@ public Builder paymentType(com.sumup.sdk.models.PaymentType paymentType) {
     /**
      * Sets the value for {@code status}.
      *
-     * @param status Current status of the transaction.
+     * @param status Current status of the transaction. - `PENDING`: The transaction has been
+     *     created but its final outcome is not known yet. - `SUCCESSFUL`: The transaction completed
+     *     successfully. - `CANCELLED`: The transaction was cancelled or otherwise reversed before
+     *     completion. - `FAILED`: The transaction attempt did not complete successfully. -
+     *     `REFUNDED`: The transaction was refunded in full or in part.
      * @return This builder instance.
      */
-    public Builder status(com.sumup.sdk.models.TransactionFullStatus status) {
+    public Builder status(com.sumup.sdk.models.TransactionStatus status) {
       this.status = status;
       return this;
     }
diff --git a/src/main/java/com/sumup/sdk/models/TransactionBase.java b/src/main/java/com/sumup/sdk/models/TransactionBase.java
@@ -21,8 +21,14 @@ public record TransactionBase(
     /** Payment type used for the transaction. */
     com.sumup.sdk.models.PaymentType paymentType,
 
-    /** Current status of the transaction. */
-    com.sumup.sdk.models.TransactionBaseStatus status,
+    /**
+     * Current status of the transaction. - `PENDING`: The transaction has been created but its
+     * final outcome is not known yet. - `SUCCESSFUL`: The transaction completed successfully. -
+     * `CANCELLED`: The transaction was cancelled or otherwise reversed before completion. -
+     * `FAILED`: The transaction attempt did not complete successfully. - `REFUNDED`: The
+     * transaction was refunded in full or in part.
+     */
+    com.sumup.sdk.models.TransactionStatus status,
 
     /**
      * Date and time of the creation of the transaction. Response format expressed according to
@@ -50,7 +56,7 @@ public static final class Builder {
     private String id;
     private Long installmentsCount;
     private com.sumup.sdk.models.PaymentType paymentType;
-    private com.sumup.sdk.models.TransactionBaseStatus status;
+    private com.sumup.sdk.models.TransactionStatus status;
     private java.time.OffsetDateTime timestamp;
     private String transactionCode;
 
@@ -115,10 +121,14 @@ public Builder paymentType(com.sumup.sdk.models.PaymentType paymentType) {
     /**
      * Sets the value for {@code status}.
      *
-     * @param status Current status of the transaction.
+     * @param status Current status of the transaction. - `PENDING`: The transaction has been
+     *     created but its final outcome is not known yet. - `SUCCESSFUL`: The transaction completed
+     *     successfully. - `CANCELLED`: The transaction was cancelled or otherwise reversed before
+     *     completion. - `FAILED`: The transaction attempt did not complete successfully. -
+     *     `REFUNDED`: The transaction was refunded in full or in part.
      * @return This builder instance.
      */
-    public Builder status(com.sumup.sdk.models.TransactionBaseStatus status) {
+    public Builder status(com.sumup.sdk.models.TransactionStatus status) {
       this.status = status;
       return this;
     }
diff --git a/src/main/java/com/sumup/sdk/models/TransactionBaseStatus.java b/src/main/java/com/sumup/sdk/models/TransactionBaseStatus.java
diff --git a/src/main/java/com/sumup/sdk/models/TransactionFull.java b/src/main/java/com/sumup/sdk/models/TransactionFull.java
@@ -130,8 +130,14 @@ public record TransactionFull(
      */
     com.sumup.sdk.models.TransactionFullSimpleStatus simpleStatus,
 
-    /** Current status of the transaction. */
-    com.sumup.sdk.models.TransactionFullStatus status,
+    /**
+     * Current status of the transaction. - `PENDING`: The transaction has been created but its
+     * final outcome is not known yet. - `SUCCESSFUL`: The transaction completed successfully. -
+     * `CANCELLED`: The transaction was cancelled or otherwise reversed before completion. -
+     * `FAILED`: The transaction attempt did not complete successfully. - `REFUNDED`: The
+     * transaction was refunded in full or in part.
+     */
+    com.sumup.sdk.models.TransactionStatus status,
 
     /** Indicates whether tax deduction is enabled for the transaction. */
     Boolean taxEnabled,
@@ -207,7 +213,7 @@ public static final class Builder {
     private java.util.List<com.sumup.sdk.models.Product> products;
     private com.sumup.sdk.models.TransactionFullSimplePaymentType simplePaymentType;
     private com.sumup.sdk.models.TransactionFullSimpleStatus simpleStatus;
-    private com.sumup.sdk.models.TransactionFullStatus status;
+    private com.sumup.sdk.models.TransactionStatus status;
     private Boolean taxEnabled;
     private java.time.OffsetDateTime timestamp;
     private Float tipAmount;
@@ -597,10 +603,14 @@ public Builder simpleStatus(com.sumup.sdk.models.TransactionFullSimpleStatus sim
     /**
      * Sets the value for {@code status}.
      *
-     * @param status Current status of the transaction.
+     * @param status Current status of the transaction. - `PENDING`: The transaction has been
+     *     created but its final outcome is not known yet. - `SUCCESSFUL`: The transaction completed
+     *     successfully. - `CANCELLED`: The transaction was cancelled or otherwise reversed before
+     *     completion. - `FAILED`: The transaction attempt did not complete successfully. -
+     *     `REFUNDED`: The transaction was refunded in full or in part.
      * @return This builder instance.
      */
-    public Builder status(com.sumup.sdk.models.TransactionFullStatus status) {
+    public Builder status(com.sumup.sdk.models.TransactionStatus status) {
       this.status = status;
       return this;
     }
diff --git a/src/main/java/com/sumup/sdk/models/TransactionFullStatus.java b/src/main/java/com/sumup/sdk/models/TransactionFullStatus.java
diff --git a/src/main/java/com/sumup/sdk/models/TransactionHistory.java b/src/main/java/com/sumup/sdk/models/TransactionHistory.java
@@ -51,8 +51,14 @@ public record TransactionHistory(
     /** Total refunded amount. */
     Double refundedAmount,
 
-    /** Current status of the transaction. */
-    com.sumup.sdk.models.TransactionFullStatus status,
+    /**
+     * Current status of the transaction. - `PENDING`: The transaction has been created but its
+     * final outcome is not known yet. - `SUCCESSFUL`: The transaction completed successfully. -
+     * `CANCELLED`: The transaction was cancelled or otherwise reversed before completion. -
+     * `FAILED`: The transaction attempt did not complete successfully. - `REFUNDED`: The
+     * transaction was refunded in full or in part.
+     */
+    com.sumup.sdk.models.TransactionStatus status,
 
     /**
      * Date and time of the creation of the transaction. Response format expressed according to
@@ -98,7 +104,7 @@ public static final class Builder {
     private Long payoutsTotal;
     private String productSummary;
     private Double refundedAmount;
-    private com.sumup.sdk.models.TransactionFullStatus status;
+    private com.sumup.sdk.models.TransactionStatus status;
     private java.time.OffsetDateTime timestamp;
     private String transactionCode;
     private com.sumup.sdk.models.TransactionId transactionId;
@@ -269,10 +275,14 @@ public Builder refundedAmount(Double refundedAmount) {
     /**
      * Sets the value for {@code status}.
      *
-     * @param status Current status of the transaction.
+     * @param status Current status of the transaction. - `PENDING`: The transaction has been
+     *     created but its final outcome is not known yet. - `SUCCESSFUL`: The transaction completed
+     *     successfully. - `CANCELLED`: The transaction was cancelled or otherwise reversed before
+     *     completion. - `FAILED`: The transaction attempt did not complete successfully. -
+     *     `REFUNDED`: The transaction was refunded in full or in part.
      * @return This builder instance.
      */
-    public Builder status(com.sumup.sdk.models.TransactionFullStatus status) {
+    public Builder status(com.sumup.sdk.models.TransactionStatus status) {
       this.status = status;
       return this;
     }
diff --git a/src/main/java/com/sumup/sdk/models/TransactionStatus.java b/src/main/java/com/sumup/sdk/models/TransactionStatus.java
