From a5ea8ca06d8f3b8902cfd7da8b4160a0ad4a48b1 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 26 Sep 2024 11:31:17 +0200 Subject: [PATCH] DHIL-3364 - Added MandateInput. --- src/openapi/orders/orders-crud.yaml | 147 ++++++++++++++++++++++++++++ 1 file changed, 147 insertions(+) diff --git a/src/openapi/orders/orders-crud.yaml b/src/openapi/orders/orders-crud.yaml index a095c3c..208f030 100644 --- a/src/openapi/orders/orders-crud.yaml +++ b/src/openapi/orders/orders-crud.yaml @@ -1001,6 +1001,15 @@ paths: }, ] /orderlines/{orderLineId}: + parameters: + - in: path + name: orderLineId + schema: + type: string + format: uuid + example: 39d37066-c59d-4807-8ae5-45c249e28d68 + required: true + description: The id of the order line to process. patch: summary: Update an order line. description: Update an order line. @@ -1112,6 +1121,20 @@ paths: example: Buckaroo-1234 required: false description: The payment reference on PSP side. + - in: query + name: paymentStatusCode + schema: + type: string + example: 190 + required: false + description: The current status of the payment. + - in: query + name: paymentStatusSubCode + schema: + type: string + example: S001 + required: false + description: The current substatus of the payment. responses: "200": description: OK @@ -1159,6 +1182,15 @@ paths: }, ] /payments/{paymentId}: + parameters: + - in: path + name: paymentId + schema: + type: string + format: uuid + example: fd09f3c5-35d9-4a1b-a98b-e46addb663f2 + required: true + description: The id of the payment to process. patch: summary: Update a payment. description: Update a payment. @@ -1183,6 +1215,15 @@ paths: $ref: "#/components/schemas/unavailable" example: { "paymentId": "dbbc3913-414e-4528-9c95-6c11a11e04ac" } /payments/{paymentId}/paymentstatuses: + parameters: + - in: path + name: paymentId + schema: + type: string + format: uuid + example: 4c7f67bd-175e-472b-86e8-f7b388754dce + required: true + description: The id of the payment to process. post: summary: Add a payment status. description: Add a payment status. @@ -1213,6 +1254,112 @@ paths: "paymentId": "f3919c07-8fa1-4ff4-a4a6-8f99106b9129", "paymentStatusId": 2, } + /mandateinputs/: + get: + summary: Find mandate inputs. + description: Find mandate inputs. + tags: + - Payment + parameters: + - in: query + name: mandateInputId + schema: + type: string + format: uuid + example: 3448e3a7-8e66-4563-ae4f-2d3ec13ca97d + required: false + description: The id of the mandate input. + - in: query + name: paymentId + schema: + type: string + format: uuid + example: 24b6300a-1d43-4ed4-8b5f-034f6471c9cb + required: false + description: The id of the payment. + - in: query + name: mandateTypeId + schema: + type: array + items: + type: integer + explode: false + required: false + description: Filter on possible types of mandates. 1 = import, 2 = invite, 3 = paper. + - in: query + name: createdBefore + schema: + type: string + format: date-time + example: 2024-03-22T09:00:00 + required: false + description: Timestamp before which the mandate input should have been created. + - in: query + name: createdAfter + schema: + type: string + format: date-time + example: 2024-03-22T09:00:00 + required: false + description: Timestamp after which the mandate input should have been created. + - in: query + name: bic + schema: + type: string + example: BUNQNL2A + required: false + description: The BIC of the mandate input. + - in: query + name: iban + schema: + type: string + example: NL15BUNQ0417164300 + required: false + description: The IBAN of the mandate input. + - in: query + name: ascription + schema: + type: string + example: J. de Vries + required: false + description: The ascription of the mandate input. + responses: + "200": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + example: + [ + { + "mandateInputId": "0a875e67-dc9f-4825-a030-d732a2adbfbc", + "paymentId": "4a7ee6ec-d218-49b7-a5bf-0107945767ee", + "mandateType": { "mandateTypeId": 1, "name": "import" }, + "createdOn": "2024-03-22T09:00:00", + "bic": "RABONL2U", + "iban": "NL44RABO0123456789", + "ascription": "J. de Vries", + }, + ] + /mandateinputs/{mandateInputId}: + parameters: + - in: path + name: mandateInputId + schema: + type: string + format: uuid + example: 279dfaf5-b744-4d66-964a-d8c0a5c05809 + required: true + description: The id of the mandate input to process. + delete: + summary: Delete a mandate input. + description: Delete a mandate input. + tags: + - Payment + responses: + "200": + description: Ok components: securitySchemes: bearerToken: