HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 3 Actions Packages Projects Releases 1 Wiki Activity

Merge pull request 'OVPAY-1637 - Add "ovPayTokenId" to GET response bodies.' (#21) from feature/OVPAY-1637 into develop

Browse Source 
Reviewed-on: #21
Reviewed-by: ovpay <j.beek@htm.nl>
This commit is contained in:
Bas Boterman 2025-03-21 14:10:01 +00:00
commit 53b36f29a8
1 changed files with 35 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
src/openapi/contracts/contracts-se.yaml
View File

@ -4,7 +4,7 @@ info:
version: "1.0"
description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
servers:
- url: https://api.integratielaag.nl/v1
- url: https://api.integratielaag.nl/abt/touchpoint/1.0
paths:
/customers/contracts:
parameters:
@ -44,6 +44,15 @@ paths:
"billingDay": 15,
"highestInvoiceTerm": 1,
"created": "2024-08-01 15:01:00.000",
"ovPayTokenId": 1337,
"_links":
{
"get_token":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1337",
"method": "GET",
},
},
},
{
"contractId": "f07253e6-c364-474c-a342-a10a4a7cf305",
@ -59,6 +68,15 @@ paths:
"billingDay": 15,
"highestInvoiceTerm": 1,
"created": "2024-08-01 15:01:00.000",
"ovPayTokenId": 1338,
"_links":
{
"get_token":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1338",
"method": "GET",
},
},
},
]
/customers/contracts/{contractId}:
@ -126,6 +144,7 @@ paths:
"termDuration": "P0Y1M0D",
"billingDay": 15,
"highestInvoiceTerm": 1,
"ovPayTokenId": 1337,
"contractVersions":
[
{
@ -180,6 +199,14 @@ paths:
"isCredit": false,
},
],
"_links":
{
"get_token":
{
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1337",
"method": "GET",
},
},
}
/customers/contracts/{contractId}/invoices:
parameters:
@ -266,11 +293,11 @@ paths:
$ref: "#/components/schemas/unavailable"
example:
{
"cancellationMoment": "termBound",
"cancellationMoment": "termBound",
"termDuration": "P1M",
"billingDay": 18,
"cancellationFrom": "2024-08-10T00:00:00",
"cancellationUntil": "2026-08-10T00:00:00"
"cancellationUntil": "2026-08-10T00:00:00",
}
/contracts/{contractId}/cancellationvalidation:
parameters:
@ -300,10 +327,7 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"end": "2024-08-10T00:00:00"
}
example: { "end": "2024-08-10T00:00:00" }
responses:
"200":
description: OK
@ -317,7 +341,7 @@ paths:
"validationMessage": "",
"end": "2024-08-10T03:59:59",
"refundAmount": "2489",
"refundMethods": [ "creditInvoice", "iDeal" ]
"refundMethods": ["creditInvoice", "iDeal"],
}
/contracts/{contractId}/cancellation:
parameters:
@ -343,15 +367,12 @@ paths:
- SE Contract Cancellation v2
requestBody:
required: true
content:
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
example:
{
"end": "2024-08-10T00:00:00",
"refundMethod": "creditInvoice"
}
{ "end": "2024-08-10T00:00:00", "refundMethod": "creditInvoice" }
responses:
"200":
description: OK
@ -363,7 +384,7 @@ paths:
{
"end": "2024-08-10T03:59:59",
"refundAmount": "2489",
"refundMethod": "creditInvoice"
"refundMethod": "creditInvoice",
}
components:
securitySchemes: