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

Merge pull request 'OVPAY-2503 - Added ovPasNumber and volgnummer to claims request.' (#58) from feature/OVPAY-2503 into develop

Browse Source 
Reviewed-on: #58
Reviewed-by: Max Martens <m.martens@htm.nl>
This commit is contained in:
Bas Boterman 2026-04-09 07:36:16 +00:00
commit 4f54aaf027
1 changed files with 43 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
src/openapi/claims/claims-forms.yaml
View File

@ -17,10 +17,10 @@ paths:
description: >
Create a claim by sending a JSON as specified in the schema. By
specifying the chipcardnumber under 'chipkaart',
a claim for OV chipcard will be send to the OVC API. If no
chipcardnumber is specified under 'chipkaart', a claim for EMV is send
to mendix.
a claim for OV chipcard will be sent to the OVC API. If no
chipcardnumber is specified under 'chipkaart', a claim for EMV/OV-pas is sent
to Mendix, where it can be handled according to the fields present
(serviceRefId + totaalbedrag or ovPasNumber + verificationCode)
parameters: []
requestBody:
content:
@ -47,8 +47,6 @@ paths:
toelichting: string
lijn: '1'
vervoertype: '1'
serviceRefId: '1'
Totaalbedrag: 0
EMV:
value:
aankomsthalte: '1'
@ -67,8 +65,28 @@ paths:
toelichting: string
lijn: '1'
vervoertype: '1'
serviceRefId: '1'
Totaalbedrag: 0
serviceRefId: 'NLOV1234567ABCDEFG'
totaalbedrag: 3.14
OV-pas:
value:
aankomsthalte: '1'
instapdatum: '2024-03-06T15:20:44.549Z'
instaptijd: '2024-03-06T15:20:44.549Z'
ingecheckt: true
uitgecheckt: true
afgeschrevenbedrag: 0
vertrekhalte: string
korting: true
iban: '1234123412341234'
naam: string
emailadres: user@example.com
uitstaptijd: '2024-03-06T15:20:44.549Z'
verwachtbedrag: 0
toelichting: string
lijn: '1'
vervoertype: '1'
ovPasNumber: '63AW974'
verificationCode: '2FQ8'
responses:
'200':
description: ok
@ -103,18 +121,19 @@ paths:
examples:
EMV:
value:
emailAddress: 'j.beek@htm.nl'
emailAddress: 'stasjo@htm.nl'
orderNumber: 'ORD1000046'
serviceReferenceId: 'NLOVA5BCD124H3Z21X'
amount: 2305
iban: 'NL98INGB0003856625'
orderDate: '2025-01-13'
productName: 'HTM 20% korting'
OVpas:
OV-pas:
value:
emailAddress: 'j.beek@htm.nl'
emailAddress: 'stasjo@htm.nl'
orderNumber: 'ORD1000046'
ovpasNumber: '63AW974'
verificationCode: '2FQ8'
iban: 'NL98INGB0003856625'
orderDate: '2025-01-13'
productName: 'HTM 20% korting'
@ -181,7 +200,7 @@ components:
iban:
type: string
description: String of length between 15 en 32 characters
example: '1234123412341234'
example: NL98INGB0003856625
naam:
type: string
emailadres:
@ -201,9 +220,16 @@ components:
type: string
serviceRefId:
type: string
Totaalbedrag:
example: NLOV1234567ABCDEFG
totaalbedrag:
type: number
format: float
ovPasNumber:
type: string
example: 63AW974
verificationCode:
type: string
example: 2FQ8
refundsEntity:
required:
- emailAddress
@ -213,7 +239,7 @@ components:
emailAddress:
type: string
format: email
example: j.beek@htm.nl
example: stasjo@htm.nl
orderNumber:
type: string
example: ORD1000046
@ -226,6 +252,9 @@ components:
ovpasNumber:
type: string
example: 63AW974
verificationCode:
type: string
example: 2FQ8
iban:
type: string
example: NL00RABO000001337