openapi: 3.1.1
info:
  title: Strex Payment Platform REST API
  description: |
    This specification describe the REST API for the Strex Payment Platform
  contact:
    name: Strex Payment AS
    url: https://www.strex.no
    email: technicalsupport@strex.no
  license:
    name: Strex Payment AS
    url: https://www.strex.no
  version: v1.0
servers:
  - url: https://api.strex.no/services/rrtl
paths:
  /v1/login:
    post:
      tags:
        - Login (Access Token)
      description: |
        This service supports login of the merchant and returns access token. Also returns access token if the refresh token is being provided in input.
      operationId: login
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's unique CorrelationID
          required: true
          schema:
            type: string
      requestBody:
        description: LoginRequest.
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/LoginRequest'
        required: true
      responses:
        "200":
          description: |
            *OK*
          headers:
            Cache-Control:
              description: |
                HTTP header to ensure clients do not cache this request.
              schema:
                type: string
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/LoginResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/LoginResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Cache-Control:
              description: |
                HTTP header to ensure clients do not cache this request.
              schema:
                type: string
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Unauthorized*
          headers:
            Cache-Control:
              description: |
                HTTP header to ensure clients do not cache this request.
              schema:
                type: string
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      x-codegen-request-body-name: loginRequest
  /transactions/v1/sell:
    post:
      tags:
        - Financial
      summary: Post Sell transaction
      description: |
        The Sell function represents a payment for goods or services 
        and allows a merchant to charge the end user. 
        The API is in most cases synchronous, in case of pending user confirmation or registration it will be asynchronous. GET request can be used to retreive status in both cases

      operationId: transactions
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
      requestBody:
        description: Transaction.
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/SellRequest'
        required: true
      responses:
        "201":
          description: |
            Sell request created
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
        "202":
          description: |
            Accepted - Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: requestTransaction
  /transactions/v1/reverse:
    post:
      tags:
        - Financial
      summary: Post Reverse transaction
      description: |
        Creates a request for reversing a sell transaction. 
        The API is synchronous. GET request can always be used to retreive status

      operationId: reverse
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
      requestBody:
        description: Reverse transaction request
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/ReverseRequest'
        required: true
      responses:
        "201":
          description: |
            Reverse request created. Use GET to receive status.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
        "202":
          description: |
            Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: requestReverse
  /transactions/v1/reverse/{Id}:
    get:
      tags:
        - Financial
      summary: Get Reverse transaction details
      description: |
        Get transaction details of a reverse transaction
      operationId: getReverse
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: Id
          in: path
          description: |
            Could be either a CorrelationID or Strex transactionId
          required: true
          schema:
            type: string
        - name: lookupBy
          in: query
          description: |
            Should be "correlationId" or "transactionId" only
          schema:
            type: string
          example: correlationId
      responses:
        "200":
          description: |
            *OK* - Successful.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
        "202":
          description: |
            Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ReverseResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /transactions/v1/partialReverse:
    post:
      tags:
        - Financial
      summary: Post Partial Reverse transaction
      description: |
        Creates a request to partially reverse the sell transaction.
        The API is synchronous. GET request can always be used to retreive status
      operationId: partialReverse
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
      requestBody:
        description: Partial Reverse of sell
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/PartialReverseRequest'
        required: true
      responses:
        "201":
          description: |
            Partial reverse request created.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
        "202":
          description: |
            Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: requestPartialReverse
  /transactions/v1/partialReverse/{Id}:
    get:
      tags:
        - Financial
      summary: Get Partial Reverse transaction details
      description: Get Partial Reverse transaction details
      operationId: getPartialReverse
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: Id
          in: path
          description: |
            Could be either a CorrelationID or Strex transactionId
          required: true
          schema:
            type: string
        - name: lookupBy
          in: query
          description: |
            Should be "correlationId" or "transactionId" only
          schema:
            type: string
          example: correlationId
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PartialReverseResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /services/v1/userStatus:
    get:
      tags:
        - User Information
      summary: Get User Status
      description: This function returns information about an End Users registration status on the Strex Payment Service.
      operationId: GetUserStatus
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: msisdn
          in: query
          description: msisdn
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetUserStatusResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetUserStatusResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /transactions/v1/sell/{Id}:
    get:
      tags:
        - Financial
      summary: Get Sell transaction details
      description: |
        Get sell transaction details by transactionId or correlationId
      operationId: getTransactionsById
      parameters:
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: Id
          in: path
          description: |
            Could be either a CorrelationID or Strex transactionId
          required: true
          schema:
            type: string
        - name: lookupBy
          in: query
          description: |
            Should be "correlationId" or "transactionId" only
          schema:
            type: string
          example: correlationId
      responses:
        "200":
          description: |
            *OK* - Transaction retrived successfully.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
        "202":
          description: |
            Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SellResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /transactions/v1/confirmSMS/{Id}:
    get:
      tags:
        - Messaging
      description: |
        Returns the status of a confirmation SMS previously sent to an end user.
        Use this to verify if the user has confirmed or declined the request.
      summary: Get Confirm SMS transaction details
      operationId: getConfrmSMS
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
        - name: Id
          in: path
          description: |
            Could be either a CorrelationID or Strex transactionId
          required: true
          schema:
            type: string
        - name: lookupBy
          in: query
          description: |
            Should be "correlationId" or "transactionId" only
          schema:
            type: string
          example: correlationId
      responses:
        "200":
          description: |
            *OK* - SMS Details retrived successfully.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
        "202":
          description: |
            Represents the response body of an asynchronous request
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /transactions/v1/sendSMS:
    post:
      tags:
        - Messaging
      description: |
        SendSMS request, used to send an SMS to a subscriber.
      summary: Post Send SMS transaction
      operationId: sendSMS
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
      requestBody:
        description: Transaction.
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/SendSMSRequest'
        required: true
      responses:
        "201":
          description: |
            *OK* - Transaction successful.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SendSMSResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/SendSMSResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: requestTransaction
  /transactions/v1/confirmSMS:
    post:
      tags:
        - Messaging
      description: |
        Sends a SMS where the End User confirmation by replying “ok” or “Ja” on a SMS, or decline with "Nei".
        The SMS is sent from a 13 digit sender address smsOriginator+9 digits.
      summary: Post Confirm SMS transaction
      operationId: confirmSMS
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: |
            client's locale
          schema:
            type: string
      requestBody:
        description: Confirm SMS Request.
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/ConfirmSMSRequest'
        required: true
      responses:
        "200":
          description: |
            *OK* - Successful.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/ConfirmSMSResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: confirmSMS
  /services/v1/userSellEligibility:
    get:
      tags:
        - User Information
      summary: Get user Sell Eligibility
      description: Runs an extensive “sell validation check”. Based on the input parameters, the response will provide an indicative response on whether the subscriber can be charged with the given input parameters

      operationId: GetuserSellEligibility
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: msisdn
          in: query
          description: msisdn
          example: 4799999999
          required: true
          schema:
            type: string
        - name: age
          in: query
          description: age
          example: 18
          schema:
            type: integer
        - name: amount
          in: query
          description: |
            amount
          example: 10025
          required: true
          schema:
            multipleOf: 1
            pattern: ^(?!\s*$).+
            type: number
            format: number
        - name: serviceCode
          in: query
          description: serviceCode
          example: "01001"
          required: true
          schema:
            type: string
        - name: currency
          in: query
          description: currency
          example: NOK
          required: true
          schema:
            type: string
        - name: sourceOfFunds
          in: query
          description: "Merchant preferred source of funds (1=MNO bill, 2=invoice,\
            \ 3=payment card)"
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetuserSellEligibilityResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetuserSellEligibilityResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /services/v1/userSellLimits:
    get:
      tags:
        - User Information
      summary: Get user Sell Limits
      description: This function retrieves the current (snapshot at the time of the request) transaction limits for an End User.
      operationId: GetuserSellLimits
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: msisdn
          in: query
          description: msisdn
          example: 4799999999
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetuserSellLimitsResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GetuserSellLimitsResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /services/v1/generateOtp:
    post:
      tags:
        - PreAuthorisation
      summary: generate otp for authorizing other transactions
      description: generateOTP will send a One Time Password (4 digit PIN) to the End User which can be used for confirmation of a subsequent sell or preauthorize transaction.
      operationId: generateOtp
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
      requestBody:
        description: request
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/GenerateOTPRequest'
        required: true
      responses:
        "200":
          description: Success
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GenerateOTPResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/GenerateOTPResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: request
  /services/v1/preAuthorisation:
    post:
      tags:
        - PreAuthorisation
      summary: Create A PreAuthorisation token
      description: "Preauthorizated payments is recurring payments where the End User have confirmed that Sell transactions for a merchant can be executed without End User confirmation on each Sell. Preauthorization request returns a token to the merchant to be used in subsequent sell transactions. "

      operationId: PreAuthorisation
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
      requestBody:
        description: request
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/PreAuthorisationRequest'
        required: true
      responses:
        "200":
          description: |
            *OK* - Successful.
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PreAuthorisationResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PreAuthorisationResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: request
    delete:
      tags:
        - PreAuthorisation
      summary: Delete A PreAuthorisation token
      operationId: DeletePreAuthorisation
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: msisdn
          in: query
          description: msisdn
          required: true
          schema:
            type: string
        - name: authorizationToken
          in: query
          description: auth Token
          required: true
          schema:
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DeletePreAuthorisationResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/DeletePreAuthorisationResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /services/v1/preAuthorisation/{Id}:
    get:
      tags:
        - PreAuthorisation
      summary: Get PreAuthorisation transaction status
      description: Retrieves the transaction status of the preauthorization transaction
      operationId: GetPreAuthorisation
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
        - name: Id
          in: path
          description: |
            Could be either a CorrelationID or Strex transactionId
          required: true
          schema:
            type: string
        - name: lookupBy
          in: query
          description: |
            Should be "correlationId" or "transactionId" only
          schema:
            type: string
          example: correlationId
      responses:
        "200":
          description: |
            *OK* - Successful.
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PreAuthorisationResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/PreAuthorisationResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
  /services/v1/userRegistration:
    post:
      tags:
        - user Registration
      summary: Invokes user registration
      operationId: userRegistration
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID
          required: true
          schema:
            type: string
      requestBody:
        description: request
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/userRegistrationRequest'
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/userRegistrationResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/userRegistrationResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
      security:
        - Bearer: []
      x-codegen-request-body-name: request
  /services/v1/accountProfile:
    get:
      tags:
        - User Information
      summary: Invokes an information lookup and provides important information about
        the customer.
      description: This method serves several purposes. It is used to communicate
        important information about the consumer and confirm their eligibility to
        use carrier billing. Providing this information helps merchants with their
        risk assessment and helps them offer the best possible experience to the consumer.
      operationId: accountProfile
      parameters:
        - name: X-CorrelationID
          in: header
          description: |
            client's CorrelationID. Must be unique for all requests
          required: true
          schema:
            type: string
        - name: msisdn
          in: query
          description: The consumer's full MSISDN
          required: true
          schema:
            maxLength: 20
            type: string
      responses:
        "200":
          description: OK
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AccountProfileResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AccountProfileResponse'
        "400":
          description: |
            *Bad Request*
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "404":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "401":
          description: |
            *Role not found for api* - .
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "500":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        "503":
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
        default:
          description: |
            *Not Found* - Indicates server has not found the requested URI.
            Possibly missing path parameters, invalid web resource etc.
          headers:
            Date:
              description: |
                The date and time that the response message was sent
              schema:
                type: string
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/TransactionError'
  /v1/health:
    get:
      tags:
        - Health Check
      summary: Health check endpoint
      description: Returns the health status of the application
      operationId: healthCheck
      responses:
        "200":
          description: Application is up and running
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/HealthResponse'
            application/problem+json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/HealthResponse'
components:
  securitySchemes:
    Bearer:
      type: http
      description: "JWT token, e.g., Bearer YOUR_TOKEN"
      scheme: bearer
      bearerFormat: JWT
  schemas:
    SellRequest:
      required:
        - amount
        - businessModel
        - currency
        - msisdn
        - serviceCode
        - shortCode
      type: object
      properties:
        amount:
          multipleOf: 1
          type: number
          description: |
            amount
          format: number
          example: 10025
        currency:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            currency
          example: NOK
        timeoutInSeconds:
          type: number
          description: |
            Registration timeout in seconds
          format: number
          example: 300
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            MSISDN
          example: 4799999999
        serviceCode:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            Service Code
          example: "01001"
        businessModel:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            Business Model
          example: BUSINESSMODEL
        confirmChannel:
          type: string
          description: |
            Confirm Channel
          example: SMS
        otp:
          type: string
          description: |
            OTP
          example: 1234
        otpTransId:
          type: string
          description: |
            OTP Transaction Id
          example: 123456871234
        age:
          type: integer
          description: |
            Age
          format: int64
          example: 18
        smsMessage:
          type: string
          description: |
            SMS Message
          example: "Text message sent to End User"
        invoiceText:
          type: string
          description: |
            Invoice text
          example: "BUS TICKET"
        deliveryNotify:
          type: string
          description: |
            Delivery Notify
        validityPeriod:
          type: string
          description: |
            Validity Period
          example: 129600
        subNumber:
          type: string
          description: |
            Sub Number
          example: 123456789
        shortCode:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            Short Code
          example: 2222
        merchantSellOption:
          type: string
          description: |
            Merchant Sell Option
          example: 2
        merchantRegSmsText:
          type: string
          description: |
            Merchant registration SMS Text
          example: "You need to register to purchase this"
        paymentSourceRestr:
          type: string
          description: |
            Payment card restriction
          example: false
        authorizationToken:
          type: string
          description: |
            Pre Auth Token
          example: 2838592837586962283756
        changeDate:
          type: string
          description: |
            Validation of same user before changeDate
          example: 2023-05-01T00:00:00
          format: date-time
        teletorgReq:
          $ref: '#/components/schemas/TeletorgReq'
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Sell transaction request
    TeletorgReq:
      type: object
      properties:
        bNumber:
          type: number
          description: |
            B Number
          example: 82099999
          format: number
        startTime:
          type: string
          description: |
            Start time
          format: date-time
        duration:
          type: integer
          description: |
            Duration
          example: 350
          format: int64
        startPrice:
          type: number
          description: |
            Start Price
          example: 2800
          format: number
      description: Teletorg transactions
    ReverseRequest:
      type: object
      properties:
        origCorrelationId:
          type: string
          description: ‘correlationID’ received from merchant in the sell request.
        origTransId:
          type: string
          description: |
            Strex sell transaction ID
        refundReason:
          type: string
          description: Description of the refund
          example: Purchase returned
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Sell reverse request
    PartialReverseRequest:
      type: object
      properties:
        origTransId:
          type: string
          description: Strex transid of the sell transaction
          example: d8b32a7cbf02e90753cb6d0e8424abc3
        origCorrelationId:
          type: string
          description: ‘correlationID’ received from merchant in the sell request.
          example: 31cdcb58-a1d1-4ad1-84f8-ab08af430ee5
        amount:
          type: number
          description: Amount to be reversed. Must be less than sell amount.
          format: number
          example: 10
        refundReason:
          type: string
          description: Description of the refund
          example: Purchase cancelled
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Sell partial reverse request
    ConfirmSMSRequest:
      required:
        - msisdn
      type: object
      properties:
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          description: MSISDN of subscriber
          example: "4712345678"
        smsOriginator:
          type: string
          description: |
            The 4 digit SMS shortnumber, together with a subnumber, they form the extended shortnumber which will be the sender of the confirmation SMS. If not provided, the default shortnumber 2222 will be used.
          example: "2222"
        message:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            Message that will be sent to the subscriber instead of the default message. If not provided, the default message "Bekreft ved å svare OK på denne meldingen" will be used.
          example: "Please confirm your purchase by replying this SMS with OK or Ja. To decline reply Nei"
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Generate OTP Request
    ConfirmSMSResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
          example: 0
        resultDescription:
          type: string
          description: |
            Result Description
          example: Success
        transId:
          type: string
          description: |
            Unique Transaction Identifier
          example: f76c0ee5ad0e8604abb3d5ce2e4ee682
        status:
          type: string
          description: |
            Transaction status
          example: completed
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Confirm SMS response
    PreAuthorisationRequest:
      title: PreAuthorisationRequest
      required:
        - msisdn
      type: object
      properties:
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          description: MSISDN of subscriber
          example: "9891149234"
        confirmChannel:
          type: string
          description: confirmChannel
          example: "SMS"
        otp:
          type: string
          description: oneTimePass
          example: "1234"
        otpTransId:
          type: string
          description: otpTransId
          example: "832823989832"
        shortCode:
          type: string
          description: shortCode
          example: "2222"
        age:
          type: string
          description: age
          example: "18"
        securityLevel:
          type: string
          description: securityLevel
          example: "2"
        messagePrefix:
          type: string
          description: messagePrefix
          example: "Message prefix..."
        messageSuffix:
          type: string
          description: messageSuffix
          example: "Message suffix..."
        tokenDescription:
          type: string
          description: tokenDescription
          example: "Description of service."
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
    PreAuthorisationResponse:
      title: PreAuthorisationResponse
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        authorizationToken:
          type: string
          description: authorizationToken
        status:
          type: string
          description: |
            Transaction status
          example: completed
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
    DeletePreAuthorisationResponse:
      title: DeletePreAuthorisationResponse
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
    GenerateOTPRequest:
      required:
        - msisdn
        - recurring
      type: object
      properties:
        recurring:
          type: boolean
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          description: MSISDN
          example: "4799999999"
        smsOriginator:
          type: string
          description: SMS Originator
          example: "Strex"
        timeout:
          type: string
          description: Timeout
          example: "120"
        deliveryNotify:
          type: string
          description: Delivery notify
          example: "true"
        messageSuffix:
          type: string
          description: Message Suffix
          example: "Message suffix..."
        messagePrefix:
          type: string
          description: Message Prefix
          example: "Message prefix..."
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Generate OTP Request
    GenerateOTPResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Generate OTP response
    userRegistrationRequest:
      required:
        - message
        - msisdn
      type: object
      properties:
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          example: "4799999999"
          description: |
            MSISDN
        message:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            SMS Message
          example: Please register.
        campaignCode:
          type: string
          example: "Camp01"
          description: |
            Campaign Code
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        userRegistrationRequest
    userRegistrationResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        userRegistration response
    ReverseResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        reverse response
    PartialReverseResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        transId:
          type: string
          description: |
            Unique Transaction Identifier
          example: f76c0ee5ad0e8604abb3d5ce2e4ee682
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
          example: 0
        resultDescription:
          type: string
          description: |
            Result Description
          example: Success
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Mobile money partial reverse async response
    LoginRequest:
      required:
        - clientId
        - clientSecret
        - grantType
      type: object
      properties:
        clientId:
          pattern: ^(?!\s*$).+
          type: string
          example: "mer_merchant"
          description: "Client Id, provided when an agreement is signed with Strex"
        clientSecret:
          pattern: ^(?!\s*$).+
          type: string
          example: "ASdgfg245aFGgty"
          description: Client Secret, provided when an agreement is signed with Strex
        grantType:
          pattern: ^(?!\s*$).+
          type: string
          description: "'client_credentials' for normal login request or 'refresh_token' when login request contains refresh Token"
          example: "client_credentials|refresh_token"
      description: Login request
    LoginResponse:
      required:
        - accessToken
      type: object
      properties:
        accessToken:
          type: string
          description: Access Token
        expiresIn:
          type: integer
          description: |
            Expiry duration
        refreshExpiresIn:
          type: integer
          description: |
            Refresh Token Expiry duration
        refreshToken:
          type: string
          description: |
            refresh token
        tokenType:
          type: string
          description: |
            token type
        scope:
          type: string
          description: |
            scope
      description: Login Response
    SendSMSRequest:
      required:
        - message
        - msisdn
        - smsOriginator
      type: object
      properties:
        message:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            SMS Message
          example: "Here is your SMS message"
        msisdn:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            MSISDN, 10 digits
          example: "4712345678"
        smsOriginator:
          pattern: ^(?!\s*$).+
          type: string
          description: |
            SMS Originator. This is the sender of the SMS, e.g., "Strex" or shortnumber "2222"
          example: "2222"
        deliveryNotify:
          type: string
          description: |
            Delivery Notification flag, true/false
          example: "true"
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        SendSMS request.
    SendSMSResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
          example: 0
        resultDescription:
          type: string
          description: |
            Result Description
          example: Success
        transId:
          type: string
          description: |
            Unique Transaction Identifier
          example: f76c0ee5ad0e8604abb3d5ce2e4ee682
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        No fund transaction response
    GetUserStatusResponse:
      required:
        - msisdn
        - resultCode
        - transId
        - validity
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        msisdn:
          type: string
          description: |
            MSISDN
        validity:
          type: string
          description: |
            Validity
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Get user Info V1 Response
    HealthResponse:
      required:
        - status
      type: object
      properties:
        status:
          type: string
          description: Health status of the application
          example: UP
      description: Health check response
    GetuserSellEligibilityResponse:
      required:
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Get user Info V2Response
    GetuserSellLimitsResponse:
      required:
        - limitTrans
        - preferredSOF
        - remainderMonth
        - remainderYear
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        preferredSOF:
          type: string
          description: "subscriber's preferred source of funds (1=MNO bill, 2=invoice,\
            \ 3=payment card)"
        postpaidOrPrepaid:
          type: string
          description: |
            Potpaid or Prepaid
          example: Postpaid
        limitTrans:
          type: string
          description: subscriber's MNO subscription type (postpaid/prepaid)
        remainderMonth:
          type: string
          description: subscriber's Remainder Month
        remainderYear:
          type: string
          description: subscriber's Remiander Year
        currency:
          type: string
          description: Currency
          example: NOK
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Get user Info V3 Response
    KeyValueObject:
      required:
        - key
        - value
      type: object
      properties:
        key:
          type: string
          description: |
            key
        value:
          type: string
          description: |
            value
      description: |
        Key value data
    SellResponse:
      required:
        - msisdn
        - resultCode
        - transId
      type: object
      properties:
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
        resultDescription:
          type: string
          description: |
            Result Description
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        status:
          type: string
          description: |
            Transaction status
          example: completed
        msisdn:
          type: string
          description: |
            MSISDN
        postpaidOrPrepaid:
          type: string
          description: |
            Postpaid or Prepaid
        handlingCompany:
          type: string
          description: |
            Handling Company
        handlingCompDescr:
          type: string
          description: |
            Handling Company Description
        messageType:
          type: string
          description: |
            Message Type
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Sell transaction response
    Error:
      type: object
      properties:
        code:
          type: string
          description: |
            Code associated with the error
        message:
          type: string
          description: |
            Message associated with the error
        transId:
          type: string
          description: |
            Unique Transaction Identifier
      description: |
        Response containing descriptive error text and the error code
        type: object
    TransactionError:
      type: object
      properties:
        errorCategory:
          type: string
          description: |
            Category associated with the error
        errorCode:
          type: string
          description: |
            Code associated with the error
        errorDescription:
          type: string
          description: |
            Description associated with the error
        transId:
          type: string
          description: |
            Unique Transaction Identifier
        errorDateTime:
          type: string
          description: |
            DateTime of the error
          format: date-time
        errorParameters:
          type: array
          description: |
            errorParameters
          items:
            $ref: '#/components/schemas/KeyValueObject'
      description: |
        Response containing descriptive error text and the error code
        type: object
    AccountProfileResponse:
      required:
        - eligibility
        - msisdn
        - resultCode
        - transId
      type: object
      properties:
        transId:
          type: string
          description: |
            Unique Transaction Identifier
          example: f76c0ee5ad0e8604abb3d5ce2e4ee682
        resultCode:
          type: integer
          description: |
            Result Code
          format: int64
          example: 0
        resultDescription:
          type: string
          description: |
            Result Description
          example: Success
        msisdn:
          maxLength: 20
          type: string
          description: The consumer's full MSISDN
          example: "4799314428"
        ban:
          maxLength: 255
          type: string
          description: Carrier's unique customer identifier for the subscriber
          example: A9B2A400-8C83-45F3-B292-184BE653538A
        accountType:
          type: string
          description: Indicates the type of account
          example: postpaid
          enum:
            - prepaid
            - postpaid
            - enterprise
        eligibility:
          type: boolean
          description: True if the consumer is eligible to use carrier billing
          example: true
        accountStatus:
          type: string
          description: Indicates the status of the account
          example: active
          enum:
            - active
            - barred permanently
            - barred temporarily
            - unknown
            - invalid
        accountAlias:
          maxLength: 50
          type: string
          description: Subscriber's MSISDN or email address
          example: "6281548046374"
        accountNickname:
          maxLength: 20
          type: string
          description: Alternative description of the payment instrument
          example: "6281548046374"
        spendLimit:
          type: boolean
          description: True if the consumer has hit the carrier spend limit in last
            30 days
          example: false
        insufficientFunds:
          type: boolean
          description: True if the consumer has attempted to make a purchase and hit
            insufficient funds
          example: false
        prepaidBalance:
          type: number
          description: Indicates the account's current prepaid balance
          format: decimal
          example: 100.5
        accountTenure:
          type: string
          description: Age of account in months
          example: 6-inf
          enum:
            - 0-3
            - 3-6
            - 6-inf
        spendLimitAmount:
          type: number
          description: Amount of consumer monthly spend limit
          format: decimal
          example: 500.0
        spendLimitType:
          type: string
          description: Monthly spend limit type
          example: calendar
          enum:
            - calendar
            - rolling
        iccid:
          maxLength: 50
          type: string
          description: The phone ICCID from the account
          example: 8981100022152967705F
        imei:
          maxLength: 16
          minLength: 15
          type: string
          description: The phone IMEI from the account
          example: "490154203237518"
        imsi:
          maxLength: 50
          type: string
          description: IMSI from SIM
          example: "242013053638429"
        purchase:
          type: boolean
          description: True if the consumer has purchased within last 30 days
          example: true
        otherMerchantPurchase:
          type: boolean
          description: True if the consumer has purchased with other merchants
          example: true
        billingInformationChange:
          type: boolean
          description: True if the consumer's account billing information has changed
          example: false
        failedTransactions:
          type: string
          description: Indicates whether the total number of failed transactions is
            above or below average
          example: below-average
          enum:
            - above-average
            - below-average
        accountTopups:
          type: string
          description: Indicator of account activity over the lifetime
          example: above-average
          enum:
            - above-average
            - below-average
        monthlyAccountTopups:
          type: string
          description: Indicator of account activity on a monthly basis
          example: below-average
          enum:
            - above-average
            - below-average
        geolocation:
          maxLength: 50
          type: string
          description: The consumer's most recent location
          example: "Pune, Maharashtra, India"
        accountMsisdnCount:
          type: integer
          description: Total count of affiliated phone numbers associated with the
            same billing account
          example: 2
        email:
          maxLength: 255
          type: string
          description: Email address associated with the billing account
          example: user@example.com
        firstName:
          maxLength: 50
          type: string
          description: First name associated with the account
          example: John
        lastName:
          maxLength: 50
          type: string
          description: Last name associated with the account
          example: Doe
        age:
          type: string
          description: Age range associated with the account
          example: 26-35
          enum:
            - 0-13
            - 13-25
            - 26-35
            - 36-45
            - 46-55
            - 56-65
            - 66-inf
        autopay:
          type: boolean
          description: True if the postpaid consumer has a verified auto-pay method
          example: true
        autoTopup:
          type: boolean
          description: True if the prepaid consumer account automatically tops up
          example: false
        accountStatusOther:
          maxLength: 50
          type: string
          description: Any other indicators of activity associated with account
          example: None
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/KeyValueObject'
  responses:
    "400-BadRequest":
      description: |
        *Bad Request* - Indicates that client has sent malformed request.
        Possibly missing mandatory query parameters, invalid value
        in query parameters, validation exception etc.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "404-NotFound":
      description: |
        *Not Found* - Indicates server has not found the requested URI.
        Possibly missing path parameters, invalid web resource etc.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "403-Forbidden":
      description: |
        *Forbidden* - The server understands the request but refuses to authorize it. This status is typically used when the client does not have the necessary permissions to access the resource.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "405-MethodNotAllowed":
      description: |
        *Method Not Allowed* - The request method is known by the server but is not supported by the target resource. For example, a client might be trying to use a POST method on a resource that only supports GET .
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "409-Conflict":
      description: |
        *Conflict* -The request could not be completed due to a conflict with the current state of the target resource. This code is often used in situations where the user is trying to upload a file that already exists or there is a version control conflict .
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "412-PreconditionFailed":
      description: |
        *Precondition Failed* - One or more conditions given in the request header fields evaluated to false when tested on the server. This is often used with conditional requests, such as If-Match or If-None-Match .
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "429-TooManyRequests":
      description: '*Precondition Failed* -The user has sent too many requests in
        a given amount of time. This status code is used to prevent abuse and ensure
        fair usage of the server resources'
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "500-InternalServerError":
      description: |
        *Internal Server Error* - server failed in handling the client request.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "502-BadGateway":
      description: |
        *Bad Gateway* -The server, while acting as a gateway or proxy, received an invalid response from the upstream server it accessed in attempting to fulfill the request. This often indicates issues with the upstream server .
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "504-GatewayTimeout":
      description: |
        *Gateway Timeout* -The server, while acting as a gateway or proxy, did not receive a timely response from the upstream server specified by the URI (e.g., HTTP, FTP, LDAP) or some other auxiliary server (e.g., DNS) it needed to access in order to complete the request. .
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
    "400-BadRequest-transaction":
      description: |
        *Bad Request*
      headers:
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "400-BadRequest-login":
      description: |
        *Bad Request*
      headers:
        Cache-Control:
          description: |
            HTTP header to ensure clients do not cache this request.
          schema:
            type: string
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "401-Unauthorized-login":
      description: |
        *Unauthorized*
      headers:
        Cache-Control:
          description: |
            HTTP header to ensure clients do not cache this request.
          schema:
            type: string
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "401-roleNotFound-transaction":
      description: |
        *Role not found for api* - .
      headers:
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "404-NotFound-transaction":
      description: |
        *Not Found* - Indicates server has not found the requested URI.
        Possibly missing path parameters, invalid web resource etc.
      headers:
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "500-InternalServerError-transaction":
      description: |
        *Not Found* - Indicates server has not found the requested URI.
        Possibly missing path parameters, invalid web resource etc.
      headers:
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
    "503-Unavailable-transaction":
      description: |
        *Not Found* - Indicates server has not found the requested URI.
        Possibly missing path parameters, invalid web resource etc.
      headers:
        Date:
          description: |
            The date and time that the response message was sent
          schema:
            type: string
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/TransactionError'
  parameters:
    header-locale:
      name: Accept-Language
      in: header
      description: |
        client's locale
      schema:
        type: string
    header-authorization:
      name: Authorization
      in: header
      description: |
        Authorization Header
      required: true
      schema:
        type: string
    path-agentReference:
      name: agentReference
      in: path
      description: |
        agent reference
      required: true
      schema:
        type: string
    header-nofundcorrelationid:
      name: X-CorrelationID
      in: header
      description: |
        client's CorrelationID
      schema:
        type: string
    header-correlationid:
      name: X-CorrelationID
      in: header
      description: |
        client's CorrelationID
      required: true
      schema:
        type: string
    header-channel:
      name: channel
      in: header
      description: |
        channel
      schema:
        type: string
    header-date:
      name: Date
      in: header
      description: |
        date and time that the message was originated
      required: true
      schema:
        type: string
    path-transactionId:
      name: Id
      in: path
      description: |
        Could be either a CorrelationID or Strex transactionId
      required: true
      schema:
        type: string
    query-lookupBy:
      name: lookupBy
      in: query
      description: |
        lookupBy
      schema:
        type: string
x-original-swagger-version: "2.0"