From d5cbf06ec40c071a3d9550d12901ca4af2546118 Mon Sep 17 00:00:00 2001 From: Max Martens Date: Fri, 5 Sep 2025 18:23:03 +0200 Subject: [PATCH] Add examples for saldo and change IBAN mandate (only in CRUD for now, not yet in SE/TP) --- src/openapi/products/products-crud.yaml | 343 +++++++++++++++++++++++- 1 file changed, 336 insertions(+), 7 deletions(-) diff --git a/src/openapi/products/products-crud.yaml b/src/openapi/products/products-crud.yaml index dd73366..c67400e 100644 --- a/src/openapi/products/products-crud.yaml +++ b/src/openapi/products/products-crud.yaml @@ -1468,7 +1468,7 @@ paths: { "productId": 4, "parentProductId": 3, - "layerInfoId": { + "layerInfo": { "layerInfoId": 1, "choiceKey": "allowedGboAgeProfiles", "choiceLabel": "Wat is uw geboortedatum?", @@ -1669,6 +1669,340 @@ paths: } ] } + getDetailsFunctionalProductChangeIbanMandate: + summary: Functional product (change IBAN mandate) + value: + { + "productId": 143, + "parentProductId": null, + "layerInfo": null, + "fikoArticleNumber": null, + "isValid": true, + "isArchived": false, + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "IBAN wijzigen functioneel product", + "productDescription": "IBAN wijzigen functioneel product", + "validityPeriod": { + "validityPeriodId": 254, + "fromInclusive": "2023-12-31T23:00:00.000+00:00", + "toInclusive": "2100-12-08T04:00:00.000+00:00" + }, + "productTranslations": [ + { + "language": "en", + "name": "Change IBAN functional product", + "description": "Change IBAN functional product" + } + ], + "productOwner": { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM" + }, + "marketSegments": [ + { + "marketSegmentId": 1, + "name": "B2C" + } + ], + "customerSegments": null, + "allowedGboAgeProfiles": null, + "productCategory": { + "productCategoryId": 7, + "isTravelProduct": false, + "name": "Functioneel product" + }, + "requiredCustomerLevel": { + "requiredCustomerLevelId": 3, + "name": "profile" + }, + "requiredProducts": null, + "incompatibleProducts": null, + "mandatoryCustomerDataItems": null, + "requiredGboPersonalAttributes": null, + "tokenTypes": null, + "paymentMoment": { + "paymentMomentId": 1, + "name": "prepaid" + }, + "serviceOptions": [ + { + "serviceOptionId": 4, + "action": "cancel_notAllowed", + "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)" + }, + { + "serviceOptionId": 10, + "action": "refund_notAllowed", + "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)" + } + ], + "validityDuration": null, + "maxStartInFutureDuration": null, + "isRenewable": null, + "sendInvoice": null, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/onbekend/", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/onbekend/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": [ + { + "sellingPeriodId": 204, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "salesTouchpoint": { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": 10, + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": 572309345923, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" + } + }, + "forbiddenPaymentMethods": [ + { + "forbiddenPaymentMethodId": 1, + "name": "creditcard", + "issuer": "Mastercard" + }, + { + "forbiddenPaymentMethodId": 2, + "name": "creditcard", + "issuer": "Visa" + }, + { + "forbiddenPaymentMethodId": 3, + "name": "creditcard", + "issuer": "American Express" + } + ], + "sellingPrices": [ + { + "sellingPriceId": 187, + "taxCode": "V0", + "taxPercentage": 0.0000, + "amountExclTax": 1, + "amountInclTax": 1, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "internalPrice": 0.0000 + } + ] + }, + { + "sellingPeriodId": 448, + "fromInclusive": "2023-12-31T23:00:00.000+00:00", + "toInclusive": "2099-12-08T04:00:00.000+00:00", + "salesTouchpoint": { + "salesTouchpointId": 6, + "name": "SMP (Service Medewerker Portaal)", + "isActive": true, + "retailer": { + "retailerId": 1000, + "name": "HTM interne touchpoints", + "street": "Koningin Julianaplein", + "number": 10, + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": 572309345923, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" + } + }, + "forbiddenPaymentMethods": [ + { + "forbiddenPaymentMethodId": 1, + "name": "creditcard", + "issuer": "Mastercard" + }, + { + "forbiddenPaymentMethodId": 2, + "name": "creditcard", + "issuer": "Visa" + }, + { + "forbiddenPaymentMethodId": 3, + "name": "creditcard", + "issuer": "American Express" + } + ], + "sellingPrices": [ + { + "sellingPriceId": 383, + "taxCode": "V00", + "taxPercentage": 0.0000, + "amountExclTax": 1, + "amountInclTax": 1, + "fromInclusive": "2025-01-31T23:00:00.000+00:00", + "toInclusive": "2030-12-08T04:00:00.000+00:00", + "internalPrice": 1.0000 + } + ] + } + ], + "purchasePrices": null, + "auditTrail": [ + { + "auditTrailId": 5124, + "action": "update", + "user": "api", + "timestamp": "2025-09-05T16:06:25.823+00:00" + } + ] + } + getDetailsSaldoProduct: + summary: Saldo product + value: + { + "productId": 123, + "parentProductId": null, + "layerInfo": null, + "fikoArticleNumber": null, + "isValid": true, + "isArchived": false, + "gboPackageTemplateId": null, + "tapConnectProductCode": null, + "productName": "OV-pas saldo (1 euro)", + "productDescription": "1 euro saldo voor de OV-pas ", + "validityPeriod": { + "validityPeriodId": 123, + "fromInclusive": "2023-12-31T23:00:00.000+00:00", + "toInclusive": "2100-12-08T04:00:00.000+00:00" + }, + "productTranslations": [ + { + "language": "en", + "name": "OV-pas credit (1 euro)", + "description": "1 euro credit for the OV-pas" + } + ], + "productOwner": { + "productOwnerId": 17, + "name": "Corneel Verstoep", + "organization": "HTM" + }, + "marketSegments": [ + { + "marketSegmentId": 1, + "name": "B2C" + } + ], + "customerSegments": null, + "allowedGboAgeProfiles": null, + "productCategory": { + "productCategoryId": 8, + "isTravelProduct": true, + "name": "Saldo" + }, + "requiredCustomerLevel": { + "requiredCustomerLevelId": 1, + "name": "guest" + }, + "requiredProducts": null, + "incompatibleProducts": null, + "mandatoryCustomerDataItems": null, + "requiredGboPersonalAttributes": null, + "tokenTypes": [ + { + "tokenTypeId": 2, + "name": "OVPas physical" + }, + { + "tokenTypeId": 3, + "name": "OVPas digital" + } + ], + "paymentMoment": { + "paymentMomentId": 1, + "name": "prepaid" + }, + "serviceOptions": [ + { + "serviceOptionId": 4, + "action": "cancel_notAllowed", + "description": "Stopzetting is niet toegestaan (doorgaans in combinatie met refund_notAllowed)" + }, + { + "serviceOptionId": 10, + "action": "refund_notAllowed", + "description": "Terugbetaling niet toegestaan (doorgaans in combinatie met cancel_notAllowed)" + } + ], + "validityDuration": null, + "maxStartInFutureDuration": null, + "isRenewable": false, + "sendInvoice": false, + "imageReference": "https://web.acc.cloud.htm.nl/media/leif2leu/htm-logo-mobile.svg", + "productPageUrl": "https://web.acc.cloud.htm.nl/webshop/onbekend/", + "termsUrl": "https://web.acc.cloud.htm.nl/reisproducten/productvoorwaarden/onbekend/", + "isSellableAtHtm": true, + "needsSolvencyCheckConsumer": false, + "needsSolvencyCheckBusiness": false, + "sellingPeriods": [ + { + "sellingPeriodId": 123, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "salesTouchpoint": { + "salesTouchpointId": 3, + "name": "Website (Perplex)", + "isActive": true, + "retailer": { + "retailerId": 1001, + "name": "HTM externe touchpoints", + "street": "Koningin Julianaplein", + "number": 10, + "numberAddition": null, + "postalCode": "2595 AA", + "city": "Den Haag", + "country": "Nederland", + "emailAddress": "info@htm.nl", + "phoneNumber": "070 374 9002", + "taxId": 572309345923, + "imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg" + } + }, + "forbiddenPaymentMethods": null, + "sellingPrices": [ + { + "sellingPriceId": 123, + "taxCode": null, + "taxPercentage": null, + "amountExclTax": 100, + "amountInclTax": 100, + "fromInclusive": "2024-09-30T23:00:00.000+00:00", + "toInclusive": "2099-12-30T23:00:00.000+00:00", + "internalPrice": 0.0000 + } + ] + } + ], + "purchasePrices": null, + "auditTrail": [ + { + "auditTrailId": 5124, + "action": "update", + "user": "api", + "timestamp": "2025-09-05T16:06:25.823+00:00" + } + ] + } getDetailsGboProductSupplement: summary: TODO - GBO product (supplement with requirements) value: @@ -1681,12 +2015,7 @@ paths: { "productName": "TODO" } - getDetailsIbanMandate: - summary: TODO - IBAN mandate (functional product) - value: - { - "productName": "TODO" - } + '400': description: '400' content: