swagger.yaml

swagger: '2.0'
host: test-ml-api-adapter.mojaloop.live
basePath: /
schemes:
  - http
info:
  title: ml api adapter API Documentation
  version: '1.1'
tags: []
paths:
  /endpointcache:
    delete:
      description: The HTTP request DELETE /endpointcache is used to reset the endpoint cache by performing an stopCache and initializeCache the Admin API.
      summary: Endpoint Cache
      tags:
        - cache
      operationId: EndpointCache
      parameters:
        - type: string
          format: date
          name: date
          in: header
          required: true
      responses:
        default:
          schema:
            type: string
          description: Successful
  /health:
    get:
      summary: Status of adapter
      operationId: getHealth
      tags:
        - health
      responses:
        default:
          schema:
            type: string
          description: Successful
  /metrics:
    get:
      summary: Prometheus metrics endpoint
      operationId: getMetrics
      tags:
        - metrics
      responses:
        default:
          schema:
            type: string
          description: Successful
  /bulkTransfers/{id}:
    get:
      summary: Get a bulk transfer by Id
      operationId: getBulkTransfersId
      parameters:
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: accept
          in: header
          required: false
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: content-type
          in: header
          required: true
        - type: string
          format: date
          name: date
          in: header
          required: true
        - type: string
          name: x-forwarded-for
          in: header
          required: false
        - type: string
          name: fspiop-source
          in: header
          required: true
        - type: string
          name: fspiop-destination
          in: header
          required: false
        - type: string
          name: fspiop-encryption
          in: header
          required: false
        - type: string
          name: fspiop-signature
          in: header
          required: false
        - type: string
          name: fspiop-uri
          in: header
          required: false
        - type: string
          name: fspiop-http-method
          in: header
          required: false
        - type: string
          description: path
          x-format:
            guid: true
          name: id
          in: path
          required: true
      tags:
        - bulk-transfers
        - sampled
      responses:
        default:
          schema:
            type: string
          description: Successful
    put:
      summary: BulkTransfersByIDPut
      operationId: BulkTransfersByIDPut
      parameters:
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: content-type
          in: header
          required: true
        - type: string
          format: date
          name: date
          in: header
          required: true
        - type: string
          name: x-forwarded-for
          in: header
          required: false
        - type: string
          name: fspiop-source
          in: header
          required: true
        - type: string
          name: fspiop-destination
          in: header
          required: false
        - type: string
          name: fspiop-encryption
          in: header
          required: false
        - type: string
          name: fspiop-signature
          in: header
          required: false
        - type: string
          name: fspiop-uri
          in: header
          required: false
        - type: string
          name: fspiop-http-method
          in: header
          required: false
        - type: string
          description: path
          name: id
          in: path
          required: true
        - in: body
          name: body
          schema:
            $ref: '#/definitions/BulkTransfersIDPutResponse'
      tags:
        - bulkTransfers
      responses:
        default:
          schema:
            type: string
          description: The callback PUT /bulkTransfers/<ID> is used to inform the client of a requested or created bulk transfer. The <ID> in the URI should contain the bulkTransferId that was used for the creation of the bulk transfer (POST /bulkTransfers), or the <ID> that was used in the GET /bulkTransfers/<ID>.
  /bulkTransfers:
    post:
      summary: Transfer API.
      operationId: postBulkTransfers
      parameters:
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: accept
          in: header
          required: false
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: content-type
          in: header
          required: true
        - type: number
          maximum: 5242880
          name: content-length
          in: header
        - type: string
          format: date
          name: date
          in: header
          required: true
        - type: string
          name: x-forwarded-for
          in: header
          required: false
        - type: string
          name: fspiop-source
          in: header
          required: true
        - type: string
          name: fspiop-destination
          in: header
          required: false
        - type: string
          name: fspiop-encryption
          in: header
          required: false
        - type: string
          name: fspiop-signature
          in: header
          required: false
        - type: string
          name: fspiop-uri
          in: header
          required: false
        - type: string
          name: fspiop-http-method
          in: header
          required: false
        - in: body
          name: body
          schema:
            $ref: '#/definitions/BulkTransfersPostRequest'
      tags:
        - bulk-transfers
      responses:
        default:
          schema:
            type: string
          description: Successful
  /bulkTransfers/{id}/error:
    put:
      summary: BulkTransfersErrorByIDPut
      operationId: BulkTransfersErrorByIDPut
      parameters:
        - type: string
          pattern: 'application\/vnd.interoperability[.]'
          name: content-type
          in: header
          required: true
        - type: string
          format: date
          name: date
          in: header
          required: true
        - type: string
          name: x-forwarded-for
          in: header
          required: false
        - type: string
          name: fspiop-source
          in: header
          required: true
        - type: string
          name: fspiop-destination
          in: header
          required: false
        - type: string
          name: fspiop-encryption
          in: header
          required: false
        - type: string
          name: fspiop-signature
          in: header
          required: false
        - type: string
          name: fspiop-uri
          in: header
          required: false
        - type: string
          name: fspiop-http-method
          in: header
          required: false
        - type: string
          description: path
          name: id
          in: path
          required: true
        - in: body
          name: body
          required: true
          schema:
            $ref: '#/definitions/Error'
      tags:
        - bulkTransfersError
      responses:
        default:
          schema:
            type: string
          description: If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback PUT /bulkTransfers/<ID>/error is used. The <id> in the URI should contain the bulkTransferId that was used for the creation request of the bulk transfer (POST /bulkTransfers), or the <ID> that was used in the GET /bulkTransfers/<ID>.


definitions:
  Amount:
    type: object
    description: Amount of the transfer
    properties:
      currency:
        $ref: '#/definitions/Currency'
      amount:
        type: string
        description: Amount of the transfer
        pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
    required:
      - currency
      - amount

  Currency:
    title: Currency
    description: The currency codes defined in ISO 4217 as three-letter alphabetic codes are used as the standard naming representation for currencies.
    type: string
    minLength: 3
    maxLength: 3
    enum:
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BRL
      - BSD
      - BTN
      - BWP
      - BYN
      - BZD
      - CAD
      - CDF
      - CHF
      - CLP
      - CNY
      - COP
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GGP
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - IMP
      - INR
      - IQD
      - IRR
      - ISK
      - JEP
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SOS
      - SPL
      - SRD
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TVD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XCD
      - XDR
      - XOF
      - XPF
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMW
      - ZWD
  ExtensionModel:
    type: object
    properties:
      key:
        type: string
        description: Key
        minLength: 1
        maxLength: 32
      value:
        type: string
        description: Value
        minLength: 1
        maxLength: 128
    required:
      - key
      - value
  Extension:
    type: array
    description: extension
    minItems: 1
    maxItems: 16
    items:
      $ref: '#/definitions/ExtensionModel'
  ExtensionList:
    type: object
    description: Extension list
    properties:
      extension:
        $ref: '#/definitions/Extension'
    required:
      - extension
  IndividualTransfer:
    type: object
    properties:
      transferId:
        type: string
        description: Id of transfer
        x-format:
          guid: true
      transferAmount:
        $ref: '#/definitions/Amount'
      ilpPacket:
        type: string
        description: ilp packet
        minLength: 1
        maxLength: 32768
        pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
      condition:
        type: string
        description: Condition of transfer
        maxLength: 48
        pattern: '^[A-Za-z0-9-_]{43}$'
        x-convert:
          trim: true
      extensionList:
        type: object
        description: Extension list
        properties:
          extension:
            type: array
            description: extension
            minItems: 1
            maxItems: 16
            items:
              type: object
              properties:
                key:
                  type: string
                  description: Key
                  minLength: 1
                  maxLength: 32
                value:
                  type: string
                  description: Value
                  minLength: 1
                  maxLength: 128
              required:
                - key
                - value
        required:
          - extension
    required:
      - transferId
      - transferAmount
      - ilpPacket
      - condition
  IndividualTransferResult:
    title: IndividualTransferResult
    type: object
    description: Data model for the complex type IndividualTransferResult.
    properties:
      transferId:
        type: string
        description: Identifies messages related to the same /transfers sequence.
      fulfilment:
        type: string
        description: Fulfilment of the condition specified with the transaction. Note - Either fulfilment or errorInformation should be set, not both.
      errorInformation:
        $ref: '#/definitions/ErrorInformation'
        description: If transfer is REJECTED, error information may be provided. Note - Either fulfilment or errorInformation should be set, not both.
      extensionList:
        $ref: '#/definitions/ExtensionList'
        description: Optional extension, specific to deployment.
    required:
    - transferId
  ErrorInformation:
    type: object
    description: Error information
    properties:
      errorDescription:
        type: string
      errorCode:
        type: string
        pattern: '^[0-9]{4}'
      extensionList:
        $ref: '#/definitions/ExtensionList'
    required:
      - errorDescription
      - errorCode
  Error:
    type: object
    properties:
      errorInformation:
        $ref: '#/definitions/ErrorInformation'
    required:
      - errorInformation
  BulkTransfersPostRequest:
    type: object
    properties:
      bulkTransferId:
        type: string
        description: Id of bulk transfers
        x-format:
          guid: true
      bulkQuoteId:
        type: string
        description: Id of bulk quote
        x-format:
          guid: true
      payeeFsp:
        type: string
        description: Financial Service Provider of Payee
        minLength: 1
        maxLength: 32
      payerFsp:
        type: string
        description: Financial Service Provider of Payer
        minLength: 1
        maxLength: 32
      extensionList:
        $ref: '#/definitions/ExtensionList'
      expiration:
        type: string
        description: When the transfer expires
        pattern: >-
          ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
      individualTransfers:
        type: array
        description: individual transfers list
        minItems: 1
        items:
          $ref: '#/definitions/IndividualTransfer'
    required:
    - bulkTransferId
    - bulkQuoteId
    - payerFsp
    - payeeFsp
    - individualTransfers
    - expiration
  BulkTransfersIDPutResponse:
    type: object
    properties:
      completedTimestamp:
        type: string
        description: Time and date when the bulk transaction was completed.
      individualTransferResults:
        type: array
        minItems: 1
        maxItems: 1000
        items:
          $ref: '#/definitions/IndividualTransferResult'
        description: List of IndividualTransferResult elements.
      bulkTransferState:
        type: string
        description: The state of the bulk transfer.
      extensionList:
        $ref: '#/definitions/ExtensionList'
        description: Optional extension, specific to deployment.
    required:
    - bulkTransferState