From 6b0fe72901f530938e2f21f7d0afe1f2d6529328 Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 15 May 2025 10:52:51 +0200 Subject: [PATCH] OVPAY-1564 - ENdpoints /transfer and /replace now only support XTAT for target token. --- src/openapi/customers/SE-customers.yaml | 92 +++++++------------------ 1 file changed, 23 insertions(+), 69 deletions(-) diff --git a/src/openapi/customers/SE-customers.yaml b/src/openapi/customers/SE-customers.yaml index 61f1c92..f0a0692 100644 --- a/src/openapi/customers/SE-customers.yaml +++ b/src/openapi/customers/SE-customers.yaml @@ -1731,13 +1731,12 @@ paths: schema: $ref: "#/components/schemas/unavailable" examples: - Replace with existing token from profile: - summary: Replace with existing token from profile - description: Replace with existing token from customer profile. - value: { "ovPayToken": { "newTokenId": 10 } } Replace with new token by XTAT: summary: Replace with new token by XTAT - description: Replace with new token by XTAT. + description: | + Replace with new token by XTAT. Note however the consumer provides an XTAT to identify + the new token, this token could still be an existing token linked to the customer profile. This should + be checked beforehand. value: { "ovPayToken": @@ -1746,16 +1745,6 @@ paths: "alias": "Mijn token", }, } - Complete request body (for development only): - value: - { - "ovPayToken": - { - "newTokenId": 10, - "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", - "alias": "Mijn token", - }, - } responses: "201": description: Created @@ -2580,22 +2569,13 @@ paths: schema: $ref: "#/components/schemas/TransferRequest" examples: - Transfer of a token without PAD to an existing OVpay token: - summary: Transfer of a token without PAD to an existing OVpay token + Transfer from a token without PAD to a new token: + summary: Transfer from a token without PAD to a new token description: | - Transfer of a token without PAD to an existing OVpay token. - value: - { - "oldOvPayToken": {}, - "newOvPayToken": - { - "ovPayTokenId": 2, - } - } - Transfer of a token without PAD to a new OVpay token by xTAT: - summary: Transfer of a token without PAD to a new OVpay token by xTAT - description: | - Transfer of a token without PAD to a new OVpay token by xTAT. + Transfer of a token without PAD to a new OVpay token. Note the new token in the request is always + identified by xTAT, regardless if the new token already exists in the customer profile. If the new + token does not exist in the customer profile, the user needs to provide an alias for the new token, + and it will be created in the customer profile. value: { "oldOvPayToken": {}, @@ -2605,43 +2585,15 @@ paths: "alias": "My new token", }, } - Transfer of a token with PAD to an existing OVpay token without existing PAD: - summary: Transfer of a token with PAD to an existing OVpay token without existing PAD + Transfer from a token with PAD to a new token without existing PAD: + summary: Transfer from a token with PAD to a new token without existing PAD description: | - Transfer of a token with PAD to an existing OVpay token without existing PAD. - Note how this request is different, since it has an e-mail address on which the new - PAD should be created. This request may optionally provide an OTP for - verification of th provided email address. - value: - { - "oldOvPayToken": { "padOtp": "123456" }, - "newOvPayToken": - { - "ovPayTokenId": 2, - "padEmailAddress": "jandevries@outlook.com", - "padOtp": "678901", - }, - } - Transfer of a token with PAD to an existing OVpay token with existing PAD: - summary: Transfer of a token with PAD to an existing OVpay token with existing PAD - description: | - Transfer of a token with PAD to an existing OVpay token with existing PAD. - value: - { - "oldOvPayToken": { "padOtp": "123456" }, - "newOvPayToken": - { - "ovPayTokenId": 2, - "padOtp": "678901", - }, - } - Transfer of a token with PAD to a new token by xTAT without existing PAD: - summary: Transfer of a token with PAD to a new token by xTAT without existing PAD - description: | - Transfer of a token with PAD to a new token by xTAT without existing PAD. - Note how this request is different, since it has an e-mail address on which the new - PAD should be created. This request may optionally provide an OTP for - verification of th provided email address. + Transfer of a token with PAD to a new token by xTAT without existing PAD. Note how this request is + different, since it has an e-mail address on which the new PAD should be created. This request may + optionally provide an OTP for verification of th provided email address. + Also note the new token in the request is always identified by xTAT, regardless if the new token + already exists in the customer profile. If the new token does not exist in the customer profile, the + user needs to provide an alias for the new token, and it will be created in the customer profile. value: { "oldOvPayToken": { "padOtp": "123456" }, @@ -2653,10 +2605,13 @@ paths: "padOtp": "678901", }, } - Transfer of a token with PAD to a new token by xTAT with existing PAD: - summary: Transfer of a token with PAD to a new token by xTAT with existing PAD + Transfer from a token with PAD to a new token with existing PAD: + summary: Transfer from a token with PAD to a new token with existing PAD description: | Transfer of a token with PAD to a new token by xTAT with existing PAD. + Note that the new token in the request is always identified by xTAT, regardless if the new token + already exists in the customer profile. If the new token does not exist in the customer profile, the + user needs to provide an alias for the new token, and it will be created in the customer profile. value: { "oldOvPayToken": { "padOtp": "123456" }, @@ -2679,7 +2634,6 @@ paths: }, "newOvPayToken": { - "ovPayTokenId": 2, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "alias": "My new token", "padEmailAddress": "jandevries@outlook.com",