From 292588b7ba5687434bfdfe8946235896a91eae07 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 29 Dec 2025 12:01:12 +0100 Subject: [PATCH 1/2] OVPAY-2378 - Updated spec for /contractpayments. --- src/openapi/contracts/contracts-se.yaml | 196 ++++++++++++++++++++++-- 1 file changed, 185 insertions(+), 11 deletions(-) diff --git a/src/openapi/contracts/contracts-se.yaml b/src/openapi/contracts/contracts-se.yaml index 1a7fd29..ccf8e78 100644 --- a/src/openapi/contracts/contracts-se.yaml +++ b/src/openapi/contracts/contracts-se.yaml @@ -597,9 +597,13 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - List all contract payments for a single debtor: - summary: List all contract payments for a single debtor - description: List all contract payments for single debtor with debtor number 'D123456'. + Empty list: + summary: Empty list + description: List all contract payments for a debtor with no payments. + value: { "contractPayments": [] } + Successful direct debit: + summary: Successful direct debit + description: One payment for a debtor with a successful direct debit. value: { "contractPayments": @@ -607,8 +611,133 @@ paths: { "paymentId": "151845776", "totalAmount": "26.62", - "paymentMethod": "Twikey", + "paymentMethod": "direct_debit", "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + ], + } + Direct debit reversal: + summary: Direct debit reversal + description: One payment for a debtor with a reversed direct debit. + value: + { + "contractPayments": + [ + { + "paymentId": "151845776", + "totalAmount": "-26.62", + "paymentMethod": "direct_debit_reversal", + "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + ], + } + iDEAL payment: + summary: iDEAL payment + description: One payment for a debtor with an iDEAL payment. + value: + { + "contractPayments": + [ + { + "paymentId": "151845776", + "totalAmount": "26.62", + "paymentMethod": "ideal", + "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + ], + } + Bank transfer: + summary: Bank transfer + description: One payment for a debtor with a bank transfer. + value: + { + "contractPayments": + [ + { + "paymentId": "151845776", + "totalAmount": "26.62", + "paymentMethod": "bank_transfer", + "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + ], + } + List of four payments for one invoice: + summary: List of four payments for one invoice + description: Four payments for a debtor for one invoice; a direct debit, a direct debit reversal, a bank transfer and an iDEAL payment. + value: + { + "contractPayments": + [ + { + "paymentId": "151845776", + "totalAmount": "26.62", + "paymentMethod": "direct_debit", + "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", "invoice": { "invoiceId": "147722263", @@ -626,22 +755,67 @@ paths: }, }, { - "paymentId": "151845851", - "totalAmount": "45.21", - "paymentMethod": "Twikey", + "paymentId": "151845776", + "totalAmount": "-26.62", + "paymentMethod": "direct_debit_reversal", "paymentDate": "2024-09-12", + "iban": "NL25INGB******1337", "invoice": { - "invoiceId": "147722266", - "invoiceNumber": "F2024-0002", + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", "description": "HTM Maandkorting 20%", - "publicLink": "https://factuurinzien.nl/d/ddb245d6df67999eca48c4a71b5661b93038e20a/i/dp5h1i5cuu94nopiolkdst3u17vkmzo", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", }, "_links": { "get_contractdetails": { - "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/7b2f8c1a-3d9d-4c2d-960e-4471e8e28b6a", + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + { + "paymentId": "151845777", + "totalAmount": "10.00", + "paymentMethod": "bank_transfer", + "paymentDate": "2024-09-13", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", + "method": "GET", + }, + }, + }, + { + "paymentId": "151845778", + "totalAmount": "16.62", + "paymentMethod": "ideal", + "paymentDate": "2024-09-14", + "iban": "NL25INGB******1337", + "invoice": + { + "invoiceId": "147722263", + "invoiceNumber": "F2024-0001", + "description": "HTM Maandkorting 20%", + "publicLink": "https://factuurinzien.nl/d/b0aac3f42f325f5dd6abc172f723caab5956524d/i/ddb245d6df67999eca48c4a71b5661b93038e20a", + }, + "_links": + { + "get_contractdetails": + { + "href": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers/contracts/5ca46c1a-cb9d-4c2d-960e-4471e8e28b6a", "method": "GET", }, }, From 6d7c260e9e7774622f80acc2a7757253fc503307 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Mon, 29 Dec 2025 12:32:59 +0100 Subject: [PATCH 2/2] OVPAY-2378 - PaymentMethod in NL. --- src/openapi/contracts/contracts-se.yaml | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/openapi/contracts/contracts-se.yaml b/src/openapi/contracts/contracts-se.yaml index ccf8e78..48509a6 100644 --- a/src/openapi/contracts/contracts-se.yaml +++ b/src/openapi/contracts/contracts-se.yaml @@ -611,7 +611,7 @@ paths: { "paymentId": "151845776", "totalAmount": "26.62", - "paymentMethod": "direct_debit", + "paymentMethod": "Automatische incasso", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -642,7 +642,7 @@ paths: { "paymentId": "151845776", "totalAmount": "-26.62", - "paymentMethod": "direct_debit_reversal", + "paymentMethod": "Stornering", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -673,7 +673,7 @@ paths: { "paymentId": "151845776", "totalAmount": "26.62", - "paymentMethod": "ideal", + "paymentMethod": "iDEAL", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -704,7 +704,7 @@ paths: { "paymentId": "151845776", "totalAmount": "26.62", - "paymentMethod": "bank_transfer", + "paymentMethod": "Overboeking", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -735,7 +735,7 @@ paths: { "paymentId": "151845776", "totalAmount": "26.62", - "paymentMethod": "direct_debit", + "paymentMethod": "Automatische incasso", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -757,7 +757,7 @@ paths: { "paymentId": "151845776", "totalAmount": "-26.62", - "paymentMethod": "direct_debit_reversal", + "paymentMethod": "Stornering", "paymentDate": "2024-09-12", "iban": "NL25INGB******1337", "invoice": @@ -779,7 +779,7 @@ paths: { "paymentId": "151845777", "totalAmount": "10.00", - "paymentMethod": "bank_transfer", + "paymentMethod": "Overboeking", "paymentDate": "2024-09-13", "iban": "NL25INGB******1337", "invoice": @@ -801,7 +801,7 @@ paths: { "paymentId": "151845778", "totalAmount": "16.62", - "paymentMethod": "ideal", + "paymentMethod": "iDEAL", "paymentDate": "2024-09-14", "iban": "NL25INGB******1337", "invoice":