Merge pull request #57 from firefinancialservices/ErrorCodesReview

Error codes review
firefinancialservices · Jan 28, 2025 · 5e8e755 · 5e8e755
2 parents f6039f8 + cebede1
commit 5e8e755
Show file tree

Hide file tree

Showing 62 changed files with 507 additions and 71 deletions.
diff --git a/src/fire-business-api-v1.yaml b/src/fire-business-api-v1.yaml
@@ -177,8 +177,8 @@ paths:
     $ref: ./v2/paths/paymentrequests/update-paymentrequest.yaml
 
 webhooks:
-  Webhooks:
-    $ref: ./webhooks/Webhooks.yaml
+  Webhook:
+    $ref: ./webhooks/webhooks.yaml
 
 components:
   securitySchemes:
@@ -188,7 +188,7 @@ components:
       bearerFormat: API Access Token
   responses:
     UnauthorisedError:
-      description: Access Token is Invalid or missing
+      description: An error has occured
   parameters:
     orderParam:
       name: order
@@ -373,6 +373,12 @@ components:
       $ref: 'v1/schemas/bank-pay-refund-request.yaml'
     BankPayRefundResponse: 
       $ref: 'v1/schemas/bank-pay-refund-response.yaml'
+    AppCreated:
+      $ref: 'v1/schemas/app-created.yaml'
+    ApiErrorV2:
+      $ref: 'v2/schemas/api-error.yaml'
+    ApiErrorV3:
+      $ref: 'v3/schemas/api-error.yaml'
     Events: 
       $ref: 'v2/schemas/events.yaml'
     WebhookEvents:

diff --git a/src/v1/paths/accounts/accounts-by-ican.yaml b/src/v1/paths/accounts/accounts-by-ican.yaml
@@ -19,5 +19,11 @@ get:
         application/json:
           schema:
             $ref: '#/components/schemas/Account'
-    '401':
-      $ref: ../../responses/unauthorised-error.yaml
+      '400':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '401':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '403':
+        $ref: '../../responses/unauthorised-error.yaml'
+
+
diff --git a/src/v1/paths/accounts/accounts.yaml b/src/v1/paths/accounts/accounts.yaml
@@ -11,8 +11,12 @@ get:
         application/json:
           schema:
             $ref: '../../schemas/accounts.yaml'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
     '401':
       $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
 
 post:
   summary: Create a new Fire Account
@@ -38,3 +42,9 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/Account'
+      '400':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '401':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '403':
+        $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/apps/accesstokens.yaml b/src/v1/paths/apps/accesstokens.yaml
@@ -13,9 +13,11 @@ post:
           schema:
             $ref: '#/components/schemas/AuthenticationData'
   responses:
-    '200':
-      description: Successfully authenticated
+    '201':
+      description: Access token created
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/AccessToken'
+            $ref: '#/components/schemas/AccessToken'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/apps/all-app-permissions.yaml b/src/v1/paths/apps/all-app-permissions.yaml
@@ -11,5 +11,9 @@ get:
             application/json:
               schema:
                 $ref: '../../schemas/permissions.yaml'
+        '400':
+          $ref: '../../responses/unauthorised-error.yaml'
         '401':
           $ref: '../../responses/unauthorised-error.yaml'
+        '403':
+          $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/apps/app-permissions.yaml b/src/v1/paths/apps/app-permissions.yaml
@@ -19,6 +19,10 @@ get:
             application/json:
               schema:
                 $ref: '../../schemas/permissions.yaml'
+        '400':
+          $ref: '../../responses/unauthorised-error.yaml'
         '401':
           $ref: '../../responses/unauthorised-error.yaml'
+        '403':
+          $ref: '../../responses/unauthorised-error.yaml'
 
diff --git a/src/v1/paths/apps/apps.yaml b/src/v1/paths/apps/apps.yaml
@@ -13,13 +13,15 @@ get:
             type: array
             items:            
               $ref: '../../schemas/applications.yaml' 
-    '403':
-      $ref: ../../responses/unauthorised-error.yaml
-    '401':
-      $ref: ../../responses/unauthorised-error.yaml
+      '400':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '401':
+        $ref: '../../responses/unauthorised-error.yaml'
+      '403':
+        $ref: '../../responses/unauthorised-error.yaml'
 post:
   summary: Create an API Application
-  description: This endpoint will create a new API Application on your Fire account with your chosen specified permissions
+  description: This endpoint will create a new API Application on your Fire account with your chosen specified permissions. Please note that if there is no batch approval permissions included, the approval fields must be set to null.
   tags:
     - API and Webhooks
   operationId: createApiApplication
@@ -31,10 +33,17 @@ post:
         schema:
           $ref: '#/components/schemas/NewApiApplication'
   responses:
-    '200':
+    '201':
       description: API Application created successfully
       content:
         application/json:
           schema:
-            $ref: '#/components/schemas/Application'
+            $ref: '#/components/schemas/AppCreated'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
+
 
diff --git a/src/v1/paths/aspsps/aspsps.yaml b/src/v1/paths/aspsps/aspsps.yaml
@@ -23,3 +23,9 @@ get:
           application/json:
             schema:
               $ref: ../../schemas/aspsps.yaml
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/approvers-for-batch.yaml b/src/v1/paths/batches/approvers-for-batch.yaml
@@ -19,3 +19,9 @@ get:
         application/json:
           schema:
               $ref: '#/components/schemas/BatchApprover'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/banktransfer-by-itemuuid.yaml b/src/v1/paths/batches/banktransfer-by-itemuuid.yaml
@@ -20,4 +20,10 @@ delete:
         description: The uuid of the item to remove.
   responses:
     '200':
-      description: Batch payment deleted successfully.   
+      description: Batch payment deleted successfully.   
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/banktransfers.yaml b/src/v1/paths/batches/banktransfers.yaml
@@ -35,6 +35,13 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/NewBatchItemResponse'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
+
 
 
 get:
@@ -71,4 +78,10 @@ get:
       content:
         application/json:
           schema:
-              $ref: ../../schemas/batch-items.yaml
+              $ref: ../../schemas/batch-items.yaml
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/batch-by-batchuuid.yaml b/src/v1/paths/batches/batch-by-batchuuid.yaml
@@ -14,7 +14,14 @@ delete:
         example: "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
   responses:
     '200':
-      description: Batch payment deleted successfully.      
+      description: Batch payment deleted successfully.     
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
+
 
 
 get:
@@ -38,6 +45,13 @@ get:
         application/json:
           schema:
             $ref: '#/components/schemas/Batch'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
+
 
 put:
   summary: Submit a batch
@@ -59,5 +73,11 @@ put:
       example: "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
   responses:
     '204':
-      description: No body is returned - a HTTP 204 No Content response signifies the call was successful.     
-
+      description: No body is returned - a HTTP 204 No Content response signifies the call was successful.   
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'  
+
diff --git a/src/v1/paths/batches/batches.yaml b/src/v1/paths/batches/batches.yaml
@@ -19,6 +19,12 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/NewBatchResponse'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
 
 
 get:
@@ -88,4 +94,10 @@ get:
       content:
         application/json:
           schema:
-            $ref: '../../schemas/batch-items.yaml'
+            $ref: '../../schemas/batch-items.yaml'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/internaltransfer-by-itemuuid.yaml b/src/v1/paths/batches/internaltransfer-by-itemuuid.yaml
@@ -21,4 +21,10 @@ delete:
         example: "4ADFB67A-0F5B-4A9A-9D74-34437250045C"
   responses:
     '200':
-      description: Batch payment deleted successfully. 
+      description: Batch payment deleted successfully. 
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/internaltransfers.yaml b/src/v1/paths/batches/internaltransfers.yaml
@@ -26,6 +26,12 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/NewBatchItemResponse'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
 
 
 get:
@@ -62,4 +68,10 @@ get:
       content:
         application/json:
           schema:
-              $ref: ../../schemas/batch-items.yaml
+              $ref: ../../schemas/batch-items.yaml
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/internationaltransfer-by-itemuuid.yaml b/src/v1/paths/batches/internationaltransfer-by-itemuuid.yaml
@@ -20,4 +20,10 @@ delete:
         description: The uuid of the item to remove.
   responses:
     '200':
-      description: Batch payment deleted successfully.
+      description: Batch payment deleted successfully.
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/batches/internationaltransfers.yaml b/src/v1/paths/batches/internationaltransfers.yaml
@@ -31,6 +31,12 @@ post:
         application/json:
           schema:
             $ref: '#/components/schemas/NewBatchItemResponse'
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
 
 
 get:
@@ -67,4 +73,10 @@ get:
       content:
         application/json:
           schema:
-              $ref: ../../schemas/batch-items.yaml
+              $ref: ../../schemas/batch-items.yaml
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/cards/card-block.yaml b/src/v1/paths/cards/card-block.yaml
@@ -15,3 +15,9 @@ post:
   responses:
     '204':
       description: No body is returned - “Status 204 No Content” signifies the call was successful.
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '401':
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'
diff --git a/src/v1/paths/cards/card-transactions.yaml b/src/v1/paths/cards/card-transactions.yaml
@@ -35,7 +35,9 @@ get:
             type: array
             items:            
               $ref: '../../schemas/transactions.yaml' 
-    '403':
-      $ref: ../../responses/unauthorised-error.yaml
+    '400':
+      $ref: '../../responses/unauthorised-error.yaml'
     '401':
-      $ref: ../../responses/unauthorised-error.yaml
+      $ref: '../../responses/unauthorised-error.yaml'
+    '403':
+      $ref: '../../responses/unauthorised-error.yaml'