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

OVPAY-2442 - Added POST /issuedvouchers.

Browse Source
This commit is contained in:
Bas Boterman 2026-02-13 14:17:17 +01:00
parent a71aa2e4df
commit 62f001c902
1 changed files with 114 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

121
src/openapi/products/vouchers-se.yaml
View File

@ -72,13 +72,14 @@ paths:
"isTravelProduct": false, "isTravelProduct": false,
"name": "Voucher", "name": "Voucher",
}, },
"requiredProducts": [ "requiredProducts":
{ [
"productId": 126, {
"productName": "HTM-30001", "productId": 126,
"productDescription": "Reis met 20% korting op je betaalpas bij HTM.", "productName": "HTM-30001",
}, "productDescription": "Reis met 20% korting op je betaalpas bij HTM.",
], },
],
"mandatoryCustomerDataItems": "mandatoryCustomerDataItems":
[ [
{ {
@ -392,6 +393,112 @@ paths:
"detail": "An unexpected error occurred while processing your request.", "detail": "An unexpected error occurred while processing your request.",
"instance": "/issuedvouchers", "instance": "/issuedvouchers",
} }
post:
summary: Issue a voucher for a specific product to a customer
description: |
Issue a voucher for a specific product to a customer. The voucher will be issued for the touch point that is associated with the access token used in the request.
The product for which the voucher should be issued must have active selling periods for touch points within the same retailer as the calling touch point.
tags:
- Vouchers
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Issue a single voucher:
summary: Issue a single voucher
value:
{
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"productId": 263,
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1970-01-01",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "stasjo@html.nl",
},
],
},
],
}
Issue multiple vouchers:
summary: Issue multiple vouchers
value:
{
"issuedVouchers":
[
{
"voucherCode": "VOUCHER123",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"productId": 263,
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1970-01-01",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "stasjo@html.nl",
},
],
},
{
"voucherCode": "VOUCHER456",
"fromInclusive": "2024-10-04T00:00:00.000",
"untilInclusive": "2024-11-04T00:00:00.000",
"productId": 263,
"voucherClaims":
[
{
"mandatoryCustomerDataItemId": 8,
"value": "1970-01-01",
},
{
"mandatoryCustomerDataItemId": 4,
"value": "joey@htm.nl",
},
],
},
],
}
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "#/components/schemas/unavailable"
examples:
Successfully issued a single voucher:
summary: Successfully issued a single voucher
value:
{
"issuedVoucherIds":
["d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90"],
}
Successfully issued multiple vouchers:
summary: Successfully issued multiple vouchers
value:
{
"issuedVoucherIds":
[
"d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
"a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
],
}
components: components:
securitySchemes: securitySchemes:
bearerToken: bearerToken: