Update /simple-payments/openapi.yaml

wiremock-inc · May 15, 2024 · b53021e · b53021e
1 parent 3f7706e
commit b53021e
Showing 1 changed file with 55 additions and 0 deletions.
diff --git a/simple-payments/openapi.yaml b/simple-payments/openapi.yaml
@@ -135,3 +135,58 @@ paths:
                         "created": "2023-09-03T10:31:22Z",
                         "status": "pending"
                     }
+  /charges/{chargeId}:
+    get:
+      description: Get charges by chargeId.
+      operationId: getChargesByChargeId
+      parameters:
+      - name: chargeId
+        in: path
+        required: true
+        example: 9b6b418a-0b59-486c-a4a3-cd0f1cdbf0b3
+      responses:
+        "200":
+          description: Get charge by ID
+          content:
+            application/json:
+              schema:
+                required:
+                - amount
+                - created
+                - currency
+                - customer
+                - id
+                - status
+                type: object
+                properties:
+                  id:
+                    type: string
+                    example: 9b6b418a-0b59-486c-a4a3-cd0f1cdbf0b3
+                  amount:
+                    type: integer
+                    format: int32
+                    example: 350
+                  currency:
+                    type: string
+                    example: gbp
+                  customer:
+                    type: string
+                    example: /customers/5931ed73-dcd4-4e24-ad24-975ac288fa7f
+                  created:
+                    type: string
+                    example: 2023-09-03T10:31:22Z
+                  status:
+                    type: string
+                    example: pending
+                x-wiremock-hash: 366003811
+              examples:
+                Get charge by ID:
+                  value: |-
+                    {
+                        "id": "9b6b418a-0b59-486c-a4a3-cd0f1cdbf0b3",
+                        "amount": 350,
+                        "currency": "gbp",
+                        "customer": "/customers/5931ed73-dcd4-4e24-ad24-975ac288fa7f",
+                        "created": "2023-09-03T10:31:22Z",
+                        "status": "pending"
+                    }