address comments

stellar · Dec 4, 2024 · 54f5f29 · 54f5f29
1 parent 9dfecd7
commit 54f5f29
Show file tree

Hide file tree

Showing 6 changed files with 50 additions and 13 deletions.
diff --git a/openrpc/src/anchor-platform/examples/datetime.json b/openrpc/src/anchor-platform/examples/datetime.json
@@ -22,5 +22,9 @@
     "funds_sent_at": {
         "name": "funds_sent_at",
         "value": "2023-07-04T12:34:38Z"
+    },
+    "user_action_required_by": {
+        "name": "user_action_required_by",
+        "value": "2023-07-04T12:34:38Z"
     }
 }
diff --git a/openrpc/src/anchor-platform/examples/platform_transaction.json b/openrpc/src/anchor-platform/examples/platform_transaction.json
@@ -6,6 +6,7 @@
       "sep": "31",
       "kind": "receive",
       "status": "completed",
+      "funding_method": "SWIFT",
       "amount_expected": {
         "amount": "100",
         "asset": "iso4217:USD"

diff --git a/openrpc/src/anchor-platform/schemas/customer.json b/openrpc/src/anchor-platform/schemas/customer.json
@@ -1,6 +1,5 @@
 {
   "stellar_id": {
-
     "description": "A object that identify end-user. \nFor a SEP-12 customer, the `id` field should be sufficient to fully identify the customer in the business' Backend. \nFor a SEP-31 Sending Anchor, the `account` and `memo` fields should be used. \nFor a SEP-6 or SEP-24 Anchor, the `account` and `memo` fields should be used.",
     "type": "object",
     "properties": {
@@ -17,5 +16,17 @@
           "description": "The memo value identifying a customer with a shared account, where the shared account is `account`."
       }
     }
+  },
+  "customers": {
+    "description": "The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\n            this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.",
+    "type": "object",
+    "properties": {
+      "sender": {
+        "$ref": "#/components/schemas/stellar_id"
+      },
+      "receiver": {
+        "$ref": "#/components/schemas/stellar_id"
+      }
+    }
   }
 }
diff --git a/openrpc/src/anchor-platform/schemas/datetime.json b/openrpc/src/anchor-platform/schemas/datetime.json
@@ -28,5 +28,10 @@
         "title": "transfer_received_at",
         "description": "The date and time of receiving transfer.",
         "$ref": "#/components/schemas/datetime"
+    },
+    "user_action_required_by": {
+        "title": "user_action_required_by",
+        "description": "Time and date by which user action is required.",
+        "$ref": "#/components/schemas/datetime"
     }
 }
diff --git a/openrpc/src/anchor-platform/schemas/platform_transaction.json b/openrpc/src/anchor-platform/schemas/platform_transaction.json
@@ -16,6 +16,14 @@
       "status": {
         "$ref": "#/components/schemas/status"
       },
+      "funding_method": {
+        "description": "Funding method used for transferring or settling assets.",
+        "type": "string"
+      },
+      "type": {
+        "description": "DEPRECATED in favor of funding_method. Type of deposit, withdrawal or receive.",
+        "type": "string"
+      },
       "amount_expected": {
         "$ref": "#/components/schemas/amount_expected"
       },
@@ -43,6 +51,9 @@
       "transfer_received_at": {
         "$ref": "#/components/schemas/transfer_received_at"
       },
+      "user_action_required_by": {
+        "$ref": "#/components/schemas/user_action_required_by"
+      },
       "message": {
         "description": "Human readable explanation of transaction status",
         "$ref": "#/components/schemas/message"
@@ -86,16 +97,7 @@
         "type": "string"
       },
       "customers": {
-        "description": "The Identification info of the sending and receiving customers. If they were created through [SEP-12](https://stellar.org/protocol/sep-12),\n            this object should contain the SEP-12 customer `id`. Otherwise, the `account` address of the customer.",
-        "type": "object",
-        "properties": {
-          "sender": {
-            "$ref": "#/components/schemas/stellar_id"
-          },
-          "receiver": {
-            "$ref": "#/components/schemas/stellar_id"
-          }
-        }
+        "$ref": "#/components/schemas/customers"
       },
       "creator": {
         "$ref": "#/components/schemas/stellar_id"

diff --git a/platforms/anchor-platform/api-reference/platform/rpc/anchor-platform.openrpc.json b/platforms/anchor-platform/api-reference/platform/rpc/anchor-platform.openrpc.json
@@ -904,6 +904,14 @@
                 "pending_stellar"
               ]
             },
+            "funding_method": {
+              "description": "Funding method used for transferring or settling assets.",
+              "type": "string"
+            },
+            "type": {
+              "description": "DEPRECATED in favor of funding_method. Type of deposit, withdrawal or receive.",
+              "type": "string"
+            },
             "amount_expected": {
               "type": "object",
               "title": "amount_expected",
@@ -1014,6 +1022,11 @@
               "description": "The date and time of receiving transfer.",
               "type": "string"
             },
+            "user_action_required_by": {
+              "title": "user_action_required_by",
+              "description": "Time and date by which user action is required.",
+              "type": "string"
+            },
             "message": {
               "title": "message",
               "description": "Human readable explanation of transaction status",
@@ -1149,7 +1162,7 @@
                   },
                   "created_at": {
                     "title": "created_at",
-                    "description": "The date and time when the transaction is created..",
+                    "description": "The date and time when the transaction is created.",
                     "type": "string"
                   },
                   "envelop": {
@@ -1338,10 +1351,11 @@
           "result": {
             "name": "platformTransactionResponse",
             "value": {
-              "id": "00000000-0000-0000-0000-000000000000",
+              "id": "1c186184-09ee-486c-82a7-aa7a0ab1119d",
               "sep": "31",
               "kind": "receive",
               "status": "completed",
+              "funding_method": "SWIFT",
               "amount_expected": {
                 "amount": "100",
                 "asset": "iso4217:USD"