openapi: 3.2.0
info:
  description: The Onboarding API, groups together a pool of operations for the creation of a request for a digital bank account.
  version: v1
  title: Onboarding Terms API
servers:
- description: Sandbox
  url: https://sandbox-api.novopayment.com/onboarding/v1
security:
- oAuth2ClientCredentials: []
tags:
- name: Terms
paths:
  /terms:
    get:
      summary: Get Terms And Conditions
      description: This operation obtains terms and conditions in HTML format to be displayed in a web view.
      operationId: GetTermsAndConditions
      responses:
        '200':
          $ref: '#/components/responses/RSGetTermsAndConditions200'
        '400':
          $ref: '#/components/responses/RSGetTermsAndConditions400'
        '401':
          $ref: '#/components/responses/RS401'
        '500':
          $ref: '#/components/responses/RS500'
      tags:
      - Terms
    post:
      summary: Accept Terms And Conditions
      description: 'This operation allows to accept different legal elements such as:

        - Acceptance of terms and conditions

        - Declaration of being of legal age.

        - Receive marketing notifications.'
      requestBody:
        $ref: '#/components/requestBodies/RQAcceptTermsAndConditions'
      operationId: AcceptTermsAndConditions
      responses:
        '200':
          $ref: '#/components/responses/RSAcceptTermsAndConditions200'
        '400':
          $ref: '#/components/responses/RSAcceptTermsAndConditions400'
        '401':
          $ref: '#/components/responses/RS401'
        '500':
          $ref: '#/components/responses/RS500'
      tags:
      - Terms
components:
  schemas:
    RSAcceptTermsAndConditions400:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 400.25.003
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Params required
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSGetTermsAndConditions200:
      type: object
      required:
      - code
      - message
      - datetime
      - data
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.25.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
        data:
          type: object
          required:
          - termsInHTML
          properties:
            termsInHTML:
              type: string
              description: Terms and conditions in format HTML.
              example: <html> <!-- Terms in HTML ---> <html>
              maxLength: 200
    RS500:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 500.01.999
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Internal Server Error
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          example: '2020-01-03T16:05:56.517Z'
          description: Opertion Timestamp
          format: date-time
    RS401:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 401.01.990
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Invalid Access Token
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RQAcceptTermsAndConditions:
      type: object
      required:
      - terms
      - legalAge
      properties:
        terms:
          type: boolean
          description: Acceptance of tems and conditions.
          enum:
          - true
          - false
        legalAge:
          type: boolean
          description: Acceptance of legal age.
          enum:
          - true
          - false
        marketingCampaigns:
          type: boolean
          description: Acceptance of receipt of campaign for marketing concept.
          enum:
          - true
          - false
    RSGetTermsAndConditions400:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          example: 400.25.003
          description: Operation response code
          minLength: 10
          maxLength: 10
        message:
          type: string
          example: Params required
          description: Response code description
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
    RSAcceptTermsAndConditions200:
      type: object
      required:
      - code
      - message
      - datetime
      properties:
        code:
          type: string
          description: Operation response code
          example: 200.25.000
          maxLength: 10
        message:
          type: string
          description: Response code description
          example: Process Ok
          maxLength: 140
        datetime:
          type: string
          description: Opertion Timestamp
          example: '2020-01-03T16:05:56.517Z'
          format: date-time
  examples:
    InvalidAccessToken:
      value:
        code: 401.25.990
        message: Invalid Access Token
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidSignature:
      value:
        code: 401.25.992
        message: Invalid signature
        datetime: '2020-01-03T16:05:56.517Z'
    InvalidData:
      value:
        code: 400.25.089
        message: Invalid data.
        datetime: '2020-01-03T16:05:56.517Z'
    InternalServerError:
      value:
        code: 500.25.001
        message: Internal Server Error
        datetime: '2020-01-03T16:05:56.517Z'
    AccessTokenExpired:
      value:
        code: 401.25.993
        message: Access token expired
        datetime: '2020-01-03T16:05:56.517Z'
    AccessTokenNotApproved:
      value:
        code: 401.25.991
        message: Access Token not approved
        datetime: '2020-01-03T16:05:56.517Z'
  responses:
    RS401:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS401'
          examples:
            Invalid Access Token:
              $ref: '#/components/examples/InvalidAccessToken'
            Access Token Not Approved:
              $ref: '#/components/examples/AccessTokenNotApproved'
            Invalid Signature:
              $ref: '#/components/examples/InvalidSignature'
            Access Token Expired:
              $ref: '#/components/examples/AccessTokenExpired'
    RSAcceptTermsAndConditions200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSAcceptTermsAndConditions200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
    RSGetTermsAndConditions400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSGetTermsAndConditions400'
          examples:
            Invalid Data:
              $ref: '#/components/examples/InvalidData'
    RS500:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RS500'
          examples:
            Internal Server Error:
              $ref: '#/components/examples/InternalServerError'
    RSGetTermsAndConditions200:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSGetTermsAndConditions200'
          examples:
            Success:
              value:
                code: 200.25.000
                message: Process Ok
                datetime: '2020-01-03T16:05:56.517Z'
                data:
                  termsInHTML: <html> <!-- Terms in HTML ---> <html>
    RSAcceptTermsAndConditions400:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RSAcceptTermsAndConditions400'
          examples:
            Invalid Data:
              $ref: '#/components/examples/InvalidData'
  requestBodies:
    RQAcceptTermsAndConditions:
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/RQAcceptTermsAndConditions'
      required: true
  securitySchemes:
    oAuth2ClientCredentials:
      type: oauth2
      description: 'See [Oauth2 API](https://developer.novopayment.com/api/authentication-method-and-encryption/oauth2-api)

        '
      flows:
        clientCredentials:
          tokenUrl: https://sandbox-api.novopayment.com/oauth2/token
          scopes: {}