openapi.yaml

openapi: 3.0.3
info:
  title: Reconciliation API
  version: RECONCILIATION_VERSION
paths:
  /_info:
    get:
      summary: Get server info
      operationId: getServerInfo
      tags:
        - reconciliation.v1
      responses:
        '200':
          $ref: '#/components/responses/ServerInfo'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:read
  /policies:
    post:
      summary: Create a policy
      tags:
        - reconciliation.v1
      operationId: createPolicy
      description: Create a policy
      requestBody:
        $ref: '#/components/requestBodies/Policy'
      responses:
        '201':
          $ref: '#/components/responses/Policy'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:write
    get:
      summary: List policies
      operationId: listPolicies
      tags:
        - reconciliation.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          $ref: '#/components/responses/Policies'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:read
  /policies/{policyID}:
    delete:
      summary: Delete a policy
      operationId: deletePolicy
      tags:
        - reconciliation.v1
      description: Delete a policy by its id.
      parameters:
        - $ref: '#/components/parameters/PolicyID'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:write
    get:
      summary: Get a policy
      tags:
        - reconciliation.v1
      operationId: getPolicy
      parameters:
        - $ref: '#/components/parameters/PolicyID'
      responses:
        '200':
          $ref: '#/components/responses/Policy'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:read
  /policies/{policyID}/reconciliation:
    post:
      summary: Reconcile using a policy
      tags:
        - reconciliation.v1
      operationId: reconcile
      description: Reconcile using a policy
      parameters:
        - $ref: '#/components/parameters/PolicyID'
      requestBody:
        $ref: '#/components/requestBodies/Reconciliation'
      responses:
        '200':
          $ref: '#/components/responses/Reconciliation'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:write
  /reconciliations:
    get:
      summary: List reconciliations
      operationId: listReconciliations
      tags:
        - reconciliation.v1
      parameters:
        - $ref: '#/components/parameters/PageSize'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          $ref: '#/components/responses/Reconciliations'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:read
  /reconciliations/{reconciliationID}:
    get:
      summary: Get a reconciliation
      tags:
        - reconciliation.v1
      operationId: getReconciliation
      parameters:
        - $ref: '#/components/parameters/ReconciliationID'
      responses:
        '200':
          $ref: '#/components/responses/Reconciliation'
        default:
          $ref: '#/components/responses/ErrorResponse'
      security:
        - Authorization:
            - reconciliation:read
components:
  parameters:
    PageSize:
      name: pageSize
      in: query
      description: |
        The maximum number of results to return per page.
      example: 100
      schema:
        type: integer
        format: int64
        minimum: 1
        maximum: 1000
    Cursor:
      name: cursor
      in: query
      description: |
        Parameter used in pagination requests. Maximum page size is set to 15.
        Set to the value of next for the next page of results.
        Set to the value of previous for the previous page of results.
        No other parameters can be set when this parameter is set.
      schema:
        type: string
        example: aHR0cHM6Ly9nLnBhZ2UvTmVrby1SYW1lbj9zaGFyZQ==
    PolicyID:
      name: policyID
      in: path
      schema:
        type: string
      description: The policy ID.
      example: XXX
      required: true
    ReconciliationID:
      name: reconciliationID
      in: path
      schema:
        type: string
      description: The reconciliation ID.
      example: XXX
      required: true
  responses:
    NoContent:
      description: No content
    ServerInfo:
      description: Server information
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ServerInfo'
    Policies:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PoliciesCursorResponse'
    Policy:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PolicyResponse'
    Reconciliations:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReconciliationsCursorResponse'
    Reconciliation:
      description: OK
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReconciliationResponse'
    ErrorResponse:
      description: Error response
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  requestBodies:
    Policy:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/PolicyRequest'
    Reconciliation:
      required: true
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ReconciliationRequest'
  schemas:
    PoliciesCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              maximum: 1000
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ''
            data:
              type: array
              items:
                $ref: '#/components/schemas/Policy'
    ReconciliationsCursorResponse:
      type: object
      required:
        - cursor
      properties:
        cursor:
          type: object
          required:
            - pageSize
            - hasMore
            - data
          properties:
            pageSize:
              type: integer
              format: int64
              minimum: 1
              maximum: 1000
              example: 15
            hasMore:
              type: boolean
              example: false
            previous:
              type: string
              example: YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=
            next:
              type: string
              example: ''
            data:
              type: array
              items:
                $ref: '#/components/schemas/Reconciliation'
    ServerInfo:
      type: object
      required:
        - version
      properties:
        version:
          type: string
    PolicyRequest:
      type: object
      required:
        - name
        - ledgerName
        - ledgerQuery
        - paymentsPoolID
      properties:
        name:
          type: string
          example: XXX
        ledgerName:
          type: string
          example: default
        ledgerQuery:
          type: object
          additionalProperties: true
        paymentsPoolID:
          type: string
          example: XXX
    PolicyResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Policy'
    ReconciliationRequest:
      type: object
      required:
        - reconciledAtLedger
        - reconciledAtPayments
      properties:
        reconciledAtLedger:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
        reconciledAtPayments:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
    ReconciliationResponse:
      type: object
      required:
        - data
      properties:
        data:
          $ref: '#/components/schemas/Reconciliation'
    Policy:
      type: object
      required:
        - id
        - name
        - createdAt
        - ledgerName
        - ledgerQuery
        - paymentsPoolID
      properties:
        id:
          type: string
          example: XXX
        name:
          type: string
          example: XXX
        createdAt:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
        ledgerName:
          type: string
          example: default
        ledgerQuery:
          type: object
          additionalProperties: true
        paymentsPoolID:
          type: string
          example: XXX
    Reconciliation:
      type: object
      required:
        - id
        - policyID
        - createdAt
        - reconciledAtLedger
        - reconciledAtPayments
        - status
        - paymentsBalances
        - ledgerBalances
        - driftBalances
      properties:
        id:
          type: string
          example: XXX
        policyID:
          type: string
          example: XXX
        createdAt:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
        reconciledAtLedger:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
        reconciledAtPayments:
          type: string
          format: date-time
          example: '2021-01-01T00:00:00.000Z'
        status:
          type: string
          example: COMPLETED
        paymentsBalances:
          type: object
          additionalProperties:
            type: integer
            format: bigint
        ledgerBalances:
          type: object
          additionalProperties:
            type: integer
            format: bigint
        driftBalances:
          type: object
          additionalProperties:
            type: integer
            format: bigint
        error:
          type: string
    ErrorResponse:
      type: object
      required:
        - errorCode
        - errorMessage
      properties:
        errorCode:
          type: string
          example: VALIDATION
        errorMessage:
          type: string
        details:
          type: string