From f9f22f4ccdcdf11d73ad1e67c82553867f7c4954 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Tue, 26 Nov 2024 12:21:58 +0100 Subject: [PATCH] OVPAY-680 - Added interface voor contract cancellation. --- src/openapi/contracts/contracts-se.yaml | 84 +++++++++++++++++++++++++ 1 file changed, 84 insertions(+) diff --git a/src/openapi/contracts/contracts-se.yaml b/src/openapi/contracts/contracts-se.yaml index 98ac462..1a1530b 100644 --- a/src/openapi/contracts/contracts-se.yaml +++ b/src/openapi/contracts/contracts-se.yaml @@ -238,6 +238,90 @@ paths: "isCredit": false, }, ] + /contracts/{contractId}/cancellationmoments: + parameters: + - in: header + name: X-HTM-JWT-AUTH-HEADER + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + required: true + description: The JWT of the logged in customer. + - in: path + name: contractId + schema: + type: string + format: uuid + example: 9e224750-3065-471d-af57-85b9cffa7c89 + required: true + description: The id of the contract to process. + get: + summary: Get all cancellation moments for a given contract. + description: Get all cancellation moments for a given contract. + tags: + - SE Contract Cancellation v2 + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "cancellationMoment": "termBound", + "termDuration": "P1M", + "billingDay": 18, + "cancellationFrom": "2024-08-10T00:00:00", + "cancellationUntil": "2026-08-10T00:00:00" + } + /contracts/{contractId}/cancellationvalidation: + parameters: + - in: header + name: X-HTM-JWT-AUTH-HEADER + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + required: true + description: The JWT of the logged in customer. + - in: path + name: contractId + schema: + type: string + format: uuid + example: 9e224750-3065-471d-af57-85b9cffa7c89 + required: true + description: The id of the contract to process. + get: + summary: Validate a cancellation for a given contract. + description: Validate a cancellation for a given contract. + tags: + - SE Contract Cancellation v2 + requestBody: + required: true + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "end": "2024-08-10T00:00:00" + } + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + { + "validationResult": "true", + "validationMessage": "", + "end": "2024-08-10T03:59:59", + "refundAmount": "2489", + "refundMethods": [ "creditInvoice", "iDeal" ] + } components: securitySchemes: bearerToken: