openapi: 3.0.1

info:
  title: Funds Check External Service Connector API
  description: OpenAPI Specification for the interface of an external funds availability check.
  version: 1.0.0
  
tags:
  - name: Funds Check
    description: Funds Check Endpoint
  
paths:
  /funds-check:
    post:
      tags:
        - Funds Check
      description: API for Funds Check
      requestBody:
        content:
          application/json:
            schema:
              required:
                - msgDirection
                - msgStatus
                - msgType
                - payload
                - txId
              type: object
              properties:
                msgType:
                  type: string
                  description: Type of processed message (pacs.008, camt.056, pacs.004)
                  example: pacs.008
                msgDirection:
                  type: string
                  description: Direction of processed message (SND or RCV)
                  example: RCV
                msgStatus:
                  type: string
                  description: Status of the processed message
                  example: '75000'
                payload:
                  type: string
                  description: Payload of the processed message
                  example: <?xml version="1.0"?><Document
                    xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08"><FIToFICstmrCdtTrf><GrpHdr><MsgId>RP8-01TIPS-P2R-P2E-08-25110424000</MsgId><CreDtTm>2022-01-26T11:04:24Z</CreDtTm><NbOfTxs>000000000000001</NbOfTxs><TtlIntrBkSttlmAmt
                    Ccy="EUR">9325.6</TtlIntrBkSttlmAmt><IntrBkSttlmDt>2022-01-26</IntrBkSttlmDt><SttlmInf><SttlmMtd>CLRG</SttlmMtd><ClrSys><Prtry>TIPS</Prtry></ClrSys></SttlmInf><PmtTpInf><SvcLvl><Cd>SEPA</Cd></SvcLvl><LclInstrm><Cd>INST</Cd></LclInstrm><CtgyPurp><Cd>TAXS</Cd></CtgyPurp></PmtTpInf><InstgAgt><FinInstnId><BIC>BNPAFRPP</BIC></FinInstnId></InstgAgt><InstdAgt><FinInstnId><BIC>BREDFRP0</BIC></FinInstnId></InstdAgt></GrpHdr><CdtTrfTxInf><PmtId><InstrId>IIDRP8TIPS-P2R-P2E-08-25110424000</InstrId><EndToEndId>P2R-P2E-08</EndToEndId><TxId>TIDRP8TIPS-P2R-P2E-08-25110424000</TxId></PmtId><IntrBkSttlmAmt
                    Ccy="EUR">9325.6</IntrBkSttlmAmt><AccptncDtTm>2022-01-26T11:04:24.023+02:00</AccptncDtTm><ChrgBr>SLEV</ChrgBr><UltmtDbtr><Nm>SIMONE
                    VEIL</Nm><Id><OrgId><Othr><Id>35x</Id><SchmeNm><Cd>CUST</Cd></SchmeNm><Issr>35x</Issr></Othr></OrgId></Id></UltmtDbtr><Dbtr><Nm>BNP
                    PARIBAS</Nm><PstlAdr><Ctry>FR</Ctry><AdrLine>257 Rue de
                    Paris</AdrLine><AdrLine>93100
                    Montreuil</AdrLine></PstlAdr><Id><PrvtId><DtAndPlcOfBirth><BirthDt>1987-10-28</BirthDt><PrvcOfBirth>15</PrvcOfBirth><CityOfBirth>AIXEV</CityOfBirth><CtryOfBirth>FR</CtryOfBirth></DtAndPlcOfBirth></PrvtId></Id></Dbtr><DbtrAcct><Id><IBAN>FR5500111002220033333333355</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BIC>BNPAFRPPXXX</BIC></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BIC>BREDFRP0XXX</BIC></FinInstnId></CdtrAgt><Cdtr><Nm>P2R-P2E-08</Nm><PstlAdr><Ctry>FR</Ctry><AdrLine>18
                    Quai de la Rap</AdrLine><AdrLine>75012
                    Paris</AdrLine></PstlAdr><Id><OrgId><BICOrBEI>TOTOFRPPXXX</BICOrBEI></OrgId></Id></Cdtr><CdtrAcct><Id><IBAN>FR4400111002220033333333344</IBAN></Id></CdtrAcct><UltmtCdtr><Nm>Steves
                    Saibiensituvepatanpy</Nm><Id><PrvtId><Othr><Id>168010216806162</Id><SchmeNm><Prtry>numero
                    INSEE</Prtry></SchmeNm><Issr>INSEE</Issr></Othr></PrvtId></Id></UltmtCdtr><Purp><Cd>GOVT</Cd></Purp><RmtInf><Strd><CdtrRefInf><Tp><CdOrPrtry><Cd>SCOR</Cd></CdOrPrtry><Issr>CdtrRefInf_TypeIssuer35x</Issr></Tp><Ref>CdtrRefInf_Ref35x</Ref></CdtrRefInf></Strd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>
                confirmRptPayload:
                  type: string
                  description: 
                    Payload of the pacs.002 or of the nack associated with the message,
                    if present.
                  example: 
                    <?xml version="1.0" encoding="utf-8" standalone="no"?><Document
                    xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.002.001.10"><FIToFIPmtStsRpt><GrpHdr><MsgId>06R0120220126110424473000006</MsgId><CreDtTm>2022-01-26T12:04:24.473</CreDtTm><InstgAgt><FinInstnId><BIC>BREDFRP0</BIC></FinInstnId></InstgAgt><InstdAgt><FinInstnId><BIC>IPSTFRPP</BIC></FinInstnId></InstdAgt></GrpHdr><OrgnlGrpInfAndSts><OrgnlMsgId>RP8-01TIPS-P2R-P2E-08-25110424000</OrgnlMsgId><OrgnlMsgNmId>pacs.008.001.08</OrgnlMsgNmId><GrpSts>ACCP</GrpSts></OrgnlGrpInfAndSts><TxInfAndSts><StsId>06R0120220126110424473000006</StsId><OrgnlInstrId>IIDRP8TIPS-P2R-P2E-08-25110424000</OrgnlInstrId><OrgnlEndToEndId>P2R-P2E-08</OrgnlEndToEndId><OrgnlTxId>TIDRP8TIPS-P2R-P2E-08-25110424000</OrgnlTxId><AccptncDtTm>2022-01-26T11:04:24.023+02:00</AccptncDtTm><OrgnlTxRef><PmtTpInf><SvcLvl><Cd>SEPA</Cd></SvcLvl><LclInstrm><Cd>INST</Cd></LclInstrm><CtgyPurp><Cd>TAXS</Cd></CtgyPurp></PmtTpInf><DbtrAgt><FinInstnId><BIC>BNPAFRPPXXX</BIC></FinInstnId></DbtrAgt></OrgnlTxRef></TxInfAndSts></FIToFIPmtStsRpt></Document>
                payloadId:
                  type: string
                  description: Unique reference of the message related to the payload
                  example: TIDRP8TIPS-P2R-P2E-08-25110424000
                txId:
                  type: string
                  description: Unique reference of original pacs.008.
                  example: TIDRP8TIPS-P2R-P2E-08-25110424000
                token:
                  type: string
                  description: Security token given in the capture request for outgoing / by the Token API for incoming.
                debtorIBAN:
                  type: string
                  description: Debtor International Bank Account Number of the message
                  example: FR5500111002220033333333355
                creditorIBAN:
                  type: string
                  description: Creditor International Bank Account Number of the message
                  example: FR4400111002220033333333344
                debtorBIC:
                  type: string
                  description: Debtor Bank Identifier Code of the message
                  example: BNPAFRPPXXX
                creditorBIC:
                  type: string
                  description: Creditor Bank Identifier Code of the message
                  example: BREDFRP0XXX
                debtorNm:
                  type: string
                  description: Debtor name of the message
                  example: SIMONE VEIL
                creditorNm:
                  type: string
                  description: Creditor name of the message
                  example: Steves Saibiensituvepatanpy
                intrBkSttlmAmt:
                  type: string
                  description: Amount of the message
                  example: '9325.6'
                intrBkSttlmAmtCcy:
                  type: string
                  description: Currency of the message
                  example: EUR
                circuitCd:
                  type: string
                  description: Circuit on which the message is exchanged
                  example: TIPS
                suCd:
                  type: string
                  description: Code of the payment owner Single Unit (related to bank organization)
                  example: BKNA
                proprietary:
                  type: object
                  description: Optional content received from the payment capture interface
                  example: 'addressIP:127.0.0.1, browser: IE11'
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                required:
                  - returnCode
                type: object
                properties:
                  returnCode:
                    maxLength: 2
                    minLength: 2
                    type: string
                    description: Passing or not passing return code of the control carried out(OK or KO)
                    example: OK
                  reasonCode:
                    maxLength: 30
                    minLength: 1
                    type: string
                    description: Reason code that will be returned in the event reports and the customer notifications, or pacs.002 confirmation messages.
                    example: '0477'
                  reasonLabel:
                    type: string
                    description: Reason name label
                    example: OFAC 100
              example:
                returnCode: OK
                reasonCode: '0477'
                reasonLabel: OFAC 100
        '400':
          description: Bad Request
        '401':
          description: Unauthorized Access
        '403':
          description: Forbidden
        '404':
          description: Not Found
        '405':
          description: Method Not Allowed
        '409':
          description: Conflict
        '415':
          description: Unsupported Media Type
        '429':
          description: Too Many Requests
        '500':
          description: Internal server error
        '504':
          description: Gateway Timeout