Merge pull request 'OVPAY-1637 - Add "ovPayTokenId" to GET response bodies.' (#21) from feature/OVPAY-1637 into develop
Reviewed-on: #21 Reviewed-by: ovpay <j.beek@htm.nl>
This commit is contained in:
commit
53b36f29a8
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
|
description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1
|
- url: https://api.integratielaag.nl/abt/touchpoint/1.0
|
||||||
paths:
|
paths:
|
||||||
/customers/contracts:
|
/customers/contracts:
|
||||||
parameters:
|
parameters:
|
||||||
@ -44,6 +44,15 @@ paths:
|
|||||||
"billingDay": 15,
|
"billingDay": 15,
|
||||||
"highestInvoiceTerm": 1,
|
"highestInvoiceTerm": 1,
|
||||||
"created": "2024-08-01 15:01:00.000",
|
"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",
|
"contractId": "f07253e6-c364-474c-a342-a10a4a7cf305",
|
||||||
@ -59,6 +68,15 @@ paths:
|
|||||||
"billingDay": 15,
|
"billingDay": 15,
|
||||||
"highestInvoiceTerm": 1,
|
"highestInvoiceTerm": 1,
|
||||||
"created": "2024-08-01 15:01:00.000",
|
"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}:
|
/customers/contracts/{contractId}:
|
||||||
@ -126,6 +144,7 @@ paths:
|
|||||||
"termDuration": "P0Y1M0D",
|
"termDuration": "P0Y1M0D",
|
||||||
"billingDay": 15,
|
"billingDay": 15,
|
||||||
"highestInvoiceTerm": 1,
|
"highestInvoiceTerm": 1,
|
||||||
|
"ovPayTokenId": 1337,
|
||||||
"contractVersions":
|
"contractVersions":
|
||||||
[
|
[
|
||||||
{
|
{
|
||||||
@ -180,6 +199,14 @@ paths:
|
|||||||
"isCredit": false,
|
"isCredit": false,
|
||||||
},
|
},
|
||||||
],
|
],
|
||||||
|
"_links":
|
||||||
|
{
|
||||||
|
"get_token":
|
||||||
|
{
|
||||||
|
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/tokens?ovPayTokenId=1337",
|
||||||
|
"method": "GET",
|
||||||
|
},
|
||||||
|
},
|
||||||
}
|
}
|
||||||
/customers/contracts/{contractId}/invoices:
|
/customers/contracts/{contractId}/invoices:
|
||||||
parameters:
|
parameters:
|
||||||
@ -270,7 +297,7 @@ paths:
|
|||||||
"termDuration": "P1M",
|
"termDuration": "P1M",
|
||||||
"billingDay": 18,
|
"billingDay": 18,
|
||||||
"cancellationFrom": "2024-08-10T00:00:00",
|
"cancellationFrom": "2024-08-10T00:00:00",
|
||||||
"cancellationUntil": "2026-08-10T00:00:00"
|
"cancellationUntil": "2026-08-10T00:00:00",
|
||||||
}
|
}
|
||||||
/contracts/{contractId}/cancellationvalidation:
|
/contracts/{contractId}/cancellationvalidation:
|
||||||
parameters:
|
parameters:
|
||||||
@ -300,10 +327,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/unavailable"
|
||||||
example:
|
example: { "end": "2024-08-10T00:00:00" }
|
||||||
{
|
|
||||||
"end": "2024-08-10T00:00:00"
|
|
||||||
}
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
@ -317,7 +341,7 @@ paths:
|
|||||||
"validationMessage": "",
|
"validationMessage": "",
|
||||||
"end": "2024-08-10T03:59:59",
|
"end": "2024-08-10T03:59:59",
|
||||||
"refundAmount": "2489",
|
"refundAmount": "2489",
|
||||||
"refundMethods": [ "creditInvoice", "iDeal" ]
|
"refundMethods": ["creditInvoice", "iDeal"],
|
||||||
}
|
}
|
||||||
/contracts/{contractId}/cancellation:
|
/contracts/{contractId}/cancellation:
|
||||||
parameters:
|
parameters:
|
||||||
@ -348,10 +372,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/unavailable"
|
$ref: "#/components/schemas/unavailable"
|
||||||
example:
|
example:
|
||||||
{
|
{ "end": "2024-08-10T00:00:00", "refundMethod": "creditInvoice" }
|
||||||
"end": "2024-08-10T00:00:00",
|
|
||||||
"refundMethod": "creditInvoice"
|
|
||||||
}
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: OK
|
description: OK
|
||||||
@ -363,7 +384,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"end": "2024-08-10T03:59:59",
|
"end": "2024-08-10T03:59:59",
|
||||||
"refundAmount": "2489",
|
"refundAmount": "2489",
|
||||||
"refundMethod": "creditInvoice"
|
"refundMethod": "creditInvoice",
|
||||||
}
|
}
|
||||||
components:
|
components:
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user