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

added tokenStatus updates

Browse Source
This commit is contained in:
Mirjam Herald 2025-03-28 12:27:31 +01:00
parent 976e24775e
commit c0df05301b
1 changed files with 277 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

332
src/openapi/customers/SE-customers.yaml
View File

@ -245,7 +245,7 @@ paths:
items: items:
type: integer type: integer
explode: false explode: false
description: Filter on token status. 1 = Expired, 2 = Active, 3 = Replaced, 4 = Inactive, 5 = Suspended, 6 = Removed by customer description: Filter on token status. 1 = Retired, 2 = Active, 3 = Replaced (*), 4 = On Stock, 5 = Suspended, 6 = Removed by customer (*), 7 = Renewed Active
required: false required: false
- name: expirationDate - name: expirationDate
in: query in: query
@ -293,6 +293,7 @@ paths:
{ {
"ovPayTokens": [ "ovPayTokens": [
{ {
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenType": { "tokenType": {
"tokenTypeId": 1, "tokenTypeId": 1,
@ -300,10 +301,10 @@ paths:
}, },
"alias": "MyToken", "alias": "MyToken",
"tokenStatus": { "tokenStatus": {
"tokenStatusId": 1, "tokenStatusId": 2,
"name": "Active" "name": "Active"
}, },
"expirationDate": "2023-02-01", "expirationDate": "2028-02-01",
"replacedByTokenId": 2, "replacedByTokenId": 2,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
@ -367,6 +368,7 @@ paths:
{ {
"ovPayTokens": [ "ovPayTokens": [
{ {
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenType": { "tokenType": {
"tokenTypeId": 2, "tokenTypeId": 2,
@ -374,10 +376,10 @@ paths:
}, },
"alias": "MyToken", "alias": "MyToken",
"tokenStatus": { "tokenStatus": {
"tokenStatusId": 1, "tokenStatusId": 2,
"name": "Active" "name": "Active"
}, },
"expirationDate": "2023-02-01", "expirationDate": "2028-02-01",
"replacedByTokenId": 2, "replacedByTokenId": 2,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": { "ePurse": {
@ -439,6 +441,7 @@ paths:
{ {
"ovPayTokens": [ "ovPayTokens": [
{ {
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenType": { "tokenType": {
"tokenTypeId": 2, "tokenTypeId": 2,
@ -446,10 +449,10 @@ paths:
}, },
"alias": "MyToken", "alias": "MyToken",
"tokenStatus": { "tokenStatus": {
"tokenStatusId": 1, "tokenStatusId": 2,
"name": "Active" "name": "Active"
}, },
"expirationDate": "2023-02-01", "expirationDate": "2028-02-01",
"replacedByTokenId": 2, "replacedByTokenId": 2,
"autoReloadRegistration": { "autoReloadRegistration": {
"autoReloadAmount": 500, "autoReloadAmount": 500,
@ -474,7 +477,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"birthDate": { "birthDate": {
"inaccuracyFlag": false, "inaccuracyFlag": false,
@ -483,7 +486,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"photo": { "photo": {
"inaccuracyFlag": false, "inaccuracyFlag": false,
@ -492,7 +495,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
} }
}, },
"_links": { "_links": {
@ -541,6 +544,7 @@ paths:
{ {
"ovPayTokens": [ "ovPayTokens": [
{ {
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenType": { "tokenType": {
"tokenTypeId": 2, "tokenTypeId": 2,
@ -548,10 +552,10 @@ paths:
}, },
"alias": "MyToken", "alias": "MyToken",
"tokenStatus": { "tokenStatus": {
"tokenStatusId": 1, "tokenStatusId": 2,
"name": "Active" "name": "Active"
}, },
"expirationDate": "2023-02-01", "expirationDate": "2028-02-01",
"replacedByTokenId": 2, "replacedByTokenId": 2,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": { "ePurse": {
@ -570,7 +574,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"birthDate": { "birthDate": {
"inaccuracyFlag": true, "inaccuracyFlag": true,
@ -579,7 +583,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"photo": { "photo": {
"inaccuracyFlag": false, "inaccuracyFlag": false,
@ -588,7 +592,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
} }
}, },
"_links": { "_links": {
@ -637,6 +641,7 @@ paths:
{ {
"ovPayTokens": [ "ovPayTokens": [
{ {
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenType": { "tokenType": {
"tokenTypeId": 2, "tokenTypeId": 2,
@ -644,10 +649,10 @@ paths:
}, },
"alias": "MyToken", "alias": "MyToken",
"tokenStatus": { "tokenStatus": {
"tokenStatusId": 1, "tokenStatusId": 2,
"name": "Active" "name": "Active"
}, },
"expirationDate": "2023-02-01", "expirationDate": "2028-02-01",
"replacedByTokenId": 2, "replacedByTokenId": 2,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": { "ePurse": {
@ -666,7 +671,7 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"birthDate": { "birthDate": {
"inaccuracyFlag": true, "inaccuracyFlag": true,
@ -675,16 +680,16 @@ paths:
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
}, },
"photo": { "photo": {
"inaccuracyFlag": true, "inaccuracyFlag": true,
"inaccuracyFlagReason": "T.B.D", "inaccuracyFlagReason": null,
"inaccuracyFlagSetCounter": 1, "inaccuracyFlagSetCounter": 1,
"isValidated": false, "isValidated": false,
"changeCounter": 0, "changeCounter": 0,
"maxUpdatesVerificationCount": 0, "maxUpdatesVerificationCount": 0,
"lastChangeDate": "2019-08-24T14:15:22Z" "lastChangeDate": "2024-08-24T14:15:22Z"
} }
}, },
"_links": { "_links": {
@ -726,6 +731,175 @@ paths:
} }
} }
} }
Token list with every status for tokenTypeId = 2, role = KlantenService :
summary: Token list with every status for tokenTypeId = 2, role = KlantenService
description: Token list with every status for tokenTypeId = 2, role = KlantenService
value:
{
"ovPayTokens": [
{
"customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "MyToken",
"tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 0,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null,
}
},
{
"customerProfileId": "71ec7a57-7892-4412-afee-5fb35a6f3164",
"ovPayTokenId": 6,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "MyToken",
"tokenStatus": {
"tokenStatusId": 3,
"name": "Replaced (*)"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 2,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null
}
},
{
"customerProfileId": "71ec7a57-7892-4412-afee-5fb35a6f3164",
"ovPayTokenId": 13,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "MyToken",
"tokenStatus": {
"tokenStatusId": 4,
"name": "On stock"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 2,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData":{
"name": null,
"birthDate": null,
"photo": null
}
},
{
"customerProfileId": "ece2d43c-738d-4ba8-a699-55f7e7c3a8e9",
"ovPayTokenId": 21,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "Mijn OV Pas",
"tokenStatus": {
"tokenStatusId": 5,
"name": "Suspended"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 0,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null,
}
},
{
"customerProfileId": "ece2d43c-738d-4ba8-a699-55f7e7c3a8e9",
"ovPayTokenId": 28,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "Mijn OV Pas",
"tokenStatus": {
"tokenStatusId": 6,
"name": "Removed by customer (*)"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 0,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null,
}
},
{
"customerProfileId": "9c961d08-7304-4bf5-8294-d7247c57555a",
"ovPayTokenId": 115,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "My retired token",
"tokenStatus": {
"tokenStatusId": 1,
"name": "Retired"
},
"expirationDate": "2025-02-01",
"replacedByTokenId": 0,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null,
}
},
{
"customerProfileId": "9c961d08-7304-4bf5-8294-d7247c57555a",
"ovPayTokenId": 118,
"tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"alias": "My found token",
"tokenStatus": {
"tokenStatusId": 7,
"name": "Renewed Active"
},
"expirationDate": "2028-02-01",
"replacedByTokenId": 0,
"autoReloadRegistration": null,
"ePurse": null,
"personalAccountData": {
"name": null,
"birthDate": null,
"photo": null,
}
}
],
_links: {
"self": {
"href": "https://api.integratielaag.nl/abt/1.0/touchpoint/customers/tokens",
"method": "GET"
}
}
}
post: post:
tags: tags:
- Customers - Customers
@ -796,15 +970,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn token", "alias": "Mijn token",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{
@ -856,15 +1036,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenTypeId": 2, "tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": "OV34567", "OV pasNumber": "OV34567",
"alias": "Mijn token", "alias": "Mijn token",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": { "ePurse": {
"e-PurseBalance": { "e-PurseBalance": {
@ -1004,15 +1190,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 5, "ovPayTokenId": 5,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn token", "alias": "Mijn token",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{
@ -1058,15 +1250,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 5, "ovPayTokenId": 5,
"tokenTypeId": 2, "tokenType": {
"tokenTypeId": 2,
"name": "OV-pas physical"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber":"OV34567", "OV pasNumber":"OV34567",
"alias": "Mijn token", "alias": "Mijn token",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": { "ePurse": {
"e-PurseBalance": { "e-PurseBalance": {
@ -1126,15 +1324,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 10, "ovPayTokenId": 10,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn bestaandetoken", "alias": "Mijn bestaandetoken",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{
@ -1218,7 +1422,7 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"tokenStatusId": 4 "tokenStatusId": 5
} }
} }
Update an OV pay token alias: Update an OV pay token alias:
@ -1236,7 +1440,7 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"tokenStatusId": 4, "tokenStatusId": 5,
"alias": "Mijn verloren pas" "alias": "Mijn verloren pas"
} }
} }
@ -1254,15 +1458,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn token", "alias": "Mijn token",
"tokenStatusId": 4, "tokenStatus": {
"tokenStatusId": 5,
"name": "Suspended"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{
@ -1308,15 +1518,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn nieuwe tokennaam", "alias": "Mijn nieuwe tokennaam",
"tokenStatusId": 2, "tokenStatus": {
"tokenStatusId": 2,
"name": "Active"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{
@ -1362,15 +1578,21 @@ paths:
value: value:
{ {
"ovPayToken": { "ovPayToken": {
"customerProfileId": 8, "customerProfileId": "feaaef83-a551-4283-8419-340b1ada3b55",
"ovPayTokenId": 1, "ovPayTokenId": 1,
"tokenTypeId": 1, "tokenType": {
"tokenTypeId": 1,
"name": "EMV"
},
"lastDigits": null, "lastDigits": null,
"OV pasNumber": null, "OV pasNumber": null,
"alias": "Mijn verloren pas", "alias": "Mijn verloren pas",
"tokenStatusId": 4, "tokenStatus": {
"tokenStatusId": 5,
"name": "Suspended"
},
"expirationDate": "2028-08-31T23:59:00+02:00", "expirationDate": "2028-08-31T23:59:00+02:00",
"replacedByTokenId": null, "replacedByTokenId": 0,
"autoReloadRegistration": null, "autoReloadRegistration": null,
"ePurse": null, "ePurse": null,
"personalAccountData":{ "personalAccountData":{