From aca160f65c4efd6b8cf64f618c1b4291fe75f61d Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Wed, 17 Jun 2026 16:08:06 +0200 Subject: [PATCH] OVPAY-2485 - Added SE endpoint for AGO activation. --- src/openapi/customers/SE-customers-v2.yaml | 211 ++++++++++++++++++++- 1 file changed, 209 insertions(+), 2 deletions(-) diff --git a/src/openapi/customers/SE-customers-v2.yaml b/src/openapi/customers/SE-customers-v2.yaml index 0ea36a6..5036601 100644 --- a/src/openapi/customers/SE-customers-v2.yaml +++ b/src/openapi/customers/SE-customers-v2.yaml @@ -3636,7 +3636,6 @@ paths: "vouchers": [] } } - /customers/devices: post: summary: Add a new device to a customer profile. @@ -3717,6 +3716,135 @@ paths: responses: "200": description: OK + /customers/tokens/{ovPayTokenId}/activateAgo: + parameters: + - name: ovPayTokenId + in: path + required: true + style: simple + description: Id of the OvPayToken to get product-instances for. + schema: + type: integer + example: 1 + - name: X-HTM-JWT-AUTH-HEADER + in: header + schema: + type: string + example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c + required: false + description: The JWT of a customer in case of touchpoint were customer logs in themselves + - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER + in: header + schema: + type: integer + example: 323 + required: false + description: The id of the customer Profile + - name: X-HTM-ROLE-HEADER + in: header + schema: + type: string + example: Customer + required: false + description: The role of the HTM employee in the case of the SMP + post: + tags: + - AGO + summary: Request additional OV-pas security for a token in profile. + description: Request additional OV-pas security for a token in profile. + requestBody: + content: + application/json: + schema: + $ref: "#/components/schemas/unavailable" + examples: + For self: + value: + emailAddress: null + For other: + value: + emailAddress: stasjo@htm.nl + responses: + "200": + description: OK + content: + application/json: + schema: + oneOf: + - $ref: "#/components/schemas/EmailPreApprovedResponse" + - $ref: "#/components/schemas/EmailNotPreApprovedResponse" + examples: + Email preapproved: + value: + status: Success + description: TAT Secured + Email not preapproved: + value: + uid: 7594f3ee-cd3d-40a3-8e82-73b90d16c481 + recipient: xxxxxx.user@gmail.com + key: 123456789123456789123456789abcde + description: OTP Sent + "400": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Missing Parameters: + value: + status: 400 + title: Missing Mandatory Parameter + detail: Required parameter {0} is missing. + Invalid Parameters: + value: + status: 400 + title: Invalid Parameter + detail: Required parameter {0} is invalid. + "401": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + Unauthorized: + value: + status: 401 + title: Unauthorized + detail: Invalid Access Token + "404": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + examples: + TAT not found: + value: + status: 404 + title: Not Found + detail: TAT Account Not Found + "409": + description: 409 Conflict + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + TAT Already Secured: + value: + status: 409 + title: Conflict + detail: TAT Already Secured + "500": + description: OK + content: + application/json: + schema: + $ref: "#/components/schemas/ErrorResponse" + example: + error: An unknown error has occurred components: schemas: unavailable: @@ -4603,4 +4731,83 @@ components: customerDataItem: type: string example: emailAddress - \ No newline at end of file + GenerateTatOutput: + type: object + properties: + uid: + type: string + description: >- + An uid IS A unique identifier THAT is associated with the + user. + recipient: + type: string + description: >- + A recipient IS A unique identifier THAT is associated with the + TAT owner. + key: + type: string + description: >- + A key IS a 32 character string THAT uniquely identifies the + OTP session. + EmailPreApprovedResponse: + type: object + description: >- + AN EmailPreApprovedResponse IS AN object THAT represents the response of + email pre-approval check. + properties: + status: + type: string + description: >- + A status IS A boolean THAT indicates that the provided email address + is pre-approved by the calling client app/web. + example: Success + description: + type: string + description: >- + A description IS A string THAT provides additional information + relating to the aprroval result + example: TAT Secured + EmailNotPreApprovedResponse: + type: object + description: >- + EmailNotPreApprovedResponse IS AN object THAT represents the response of + email pre-approval check. + properties: + uid: + type: string + description: A uid IS A unique identifier THAT is associated with the user. + example: 7594f3ee-cd3d-40a3-8e82-73b90d16c481 + recipient: + type: string + description: >- + A recipient IS A unique identifier THAT is associated with the TAT + owner. + example: xxxxxx.user@gmail.com + key: + type: string + description: >- + A key IS a 32 character string THAT uniquely identifies the OTP + session. + example: 123456789123456789123456789abcde + description: + type: string + description: >- + A description IS A string THAT describes the reason why the email is + not pre-approved. + example: OTP Sent + ErrorResponse: + description: Default response when an invalid request has been sent + type: object + properties: + status: + type: integer + description: >- + A status IS An integer that represents the HTTP status code of the + response. + example: 400 + title: + type: string + description: A title IS A string that provides a brief summary of the error. + detail: + type: string + description: A detail IS A string that provides more details about the error. \ No newline at end of file