Add notificationUrl to deposit request (#1761)

Rebilly · Jan 31, 2024 · 2ca63b6 · 2ca63b6
1 parent 7c208e0
commit 2ca63b6
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git a/openapi/components/requestBodies/PostDepositRequest.yaml b/openapi/components/requestBodies/PostDepositRequest.yaml
@@ -125,3 +125,19 @@ properties:
       - 'null'
     maxLength: 50
     example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
+  notificationUrl:
+    description: |-
+      URL where a server-to-server `POST` notification is sent.
+      This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
+
+      Do not interpret this notification as a confirmation,
+      complete a `GET` request to confirm the result of the transaction.
+      To ensure the request is not reattempted,
+      when the result is confirmed, respond with a `2xx` HTTP status code.
+
+      The following placeholders are available to use in this URI: `{id}` and `{result}`.
+      These placeholders are replaced the with the transaction ID and result accordingly.
+    type:
+      - 'string'
+      - 'null'
+    format: uri
diff --git a/openapi/components/schemas/DepositRequest.yaml b/openapi/components/schemas/DepositRequest.yaml
@@ -125,6 +125,21 @@ properties:
     example:
       email: email@example.com
       max: '33'
+  notificationUrl:
+    description: |-
+      URL where a server-to-server POST notification is sent.
+      This notification is sent when the transaction result is finalized after a timeout or an offsite interaction.
+
+      Do not trust this notification alone,
+      complete a GET request to confirm the result of the transaction.
+      To ensure the request is not reattempted,
+      when the result is confirmed, respond with a 2xx HTTP status code.
+
+      The following placeholders are available to use in this URI: `{id}` and `{result}`.
+    type:
+      - 'string'
+      - 'null'
+    format: uri
   createdTime:
     $ref: ./CreatedTime.yaml
   updatedTime: