openapi: 3.2.0
info:
  title: Monite Onboarding links API
  contact:
    name: Monite team
    url: https://monite.com/about/
    email: developers@monite.com
  termsOfService: https://monite.com/terms
  version: '1.0'
  description: 'Operations tagged Onboarding links across 3 of this provider''s published API definitions: monite-openapi-2023-09-01.json, monite-openapi-2024-05-25.json, monite-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.dev.monite.com/v1
  description: Development environment
- url: https://api.sandbox.monite.com/v1
  description: Sandbox environment
- url: https://api.monite.com/v1
  description: Production environment (Europe)
- url: https://us.api.monite.com/v1
  description: Production environment (North America)
- url: https://api.monite.oaknorth.co.uk/v1
  description: Oak POC environment
tags:
- name: Onboarding links
paths:
  /onboarding_links:
    post:
      tags:
      - Onboarding links
      summary: Create Onboarding Link
      operationId: post_onboarding_links
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OnboardingLinkRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingLinkPublicResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
  /payment_onboarding_links:
    post:
      tags:
      - Onboarding links
      summary: Create an onboarding link
      operationId: post_payment_onboarding_links
      parameters:
      - required: true
        schema:
          type: string
          format: date
        example: '2023-09-01'
        name: x-monite-version
        in: header
      - description: The ID of the entity that owns the requested resource.
        required: true
        schema:
          type: string
          format: uuid
          examples:
          - 9d2b4c8f-2087-4738-ba91-7359683c49a4
        name: x-monite-entity-id
        in: header
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateOnboardingLinkRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OnboardingLinkResponse'
        '405':
          description: Method Not Allowed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchemaResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
    servers:
    - url: https://api.dev.monite.com/v1
      description: Development environment
    - url: https://api.sandbox.monite.com/v1
      description: Sandbox environment
    - url: https://api.monite.com/v1
      description: Production environment (Europe)
    - url: https://us.api.monite.com/v1
      description: Production environment (North America)
    - url: https://api.monite.oaknorth.co.uk/v1
      description: Oak POC environment
components:
  schemas:
    RecipientType:
      type: string
      enum:
      - entity
      - counterpart
    OnboardingLinkResponse:
      properties:
        id:
          type: string
          format: uuid
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
        recipient:
          $ref: '#/components/schemas/Recipient'
        refresh_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
        return_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
        url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
      additionalProperties: false
      type: object
      required:
      - id
      - created_at
      - expires_at
      - recipient
      - refresh_url
      - return_url
      - url
    Recipient:
      properties:
        id:
          type: string
          format: uuid
        type:
          $ref: '#/components/schemas/RecipientType'
      additionalProperties: false
      type: object
      required:
      - id
      - type
    OnboardingLinkRequest:
      properties:
        expires_at:
          type: string
          format: date-time
        refresh_url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
        return_url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
      additionalProperties: false
      type: object
      required:
      - expires_at
      - refresh_url
      - return_url
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
      type: object
    OnboardingLinkPublicResponse:
      properties:
        id:
          type: string
          format: uuid
        entity_id:
          type: string
          format: uuid
        expires_at:
          type: string
          format: date-time
        refresh_url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
        return_url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
        url:
          type: string
          maxLength: 65536
          minLength: 1
          format: uri
      additionalProperties: false
      type: object
      required:
      - id
      - entity_id
      - expires_at
      - refresh_url
      - return_url
      - url
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
        msg:
          type: string
        type:
          type: string
      type: object
      required:
      - loc
      - msg
      - type
    CreateOnboardingLinkRequest:
      properties:
        recipient:
          $ref: '#/components/schemas/Recipient'
        refresh_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
        return_url:
          type: string
          maxLength: 2083
          minLength: 1
          format: uri
      additionalProperties: false
      type: object
      required:
      - recipient
      - refresh_url
      - return_url
    ErrorSchemaResponse:
      properties:
        error:
          $ref: '#/components/schemas/ErrorSchema'
      type: object
      required:
      - error
    ErrorSchema:
      properties:
        message:
          type: string
      type: object
      required:
      - message
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
x-refined-from:
- monite-openapi-2023-09-01.json
- monite-openapi-2024-05-25.json
- monite-openapi.yml