openapi: 3.0.1
info:
  title: Payment Status Service API
  version: 1.0.1
paths:
  /statusRpt:
    post:
      tags:
        - Payment Status Report
      description: API for payment status
      operationId: responsePaymentStatus
      requestBody:
        content:
          application/json:
            schema:
              required:
                - msgDirection
                - msgStatus
                - msgStatusTmstp
                - msgType
                - notifType
                - payload
                - payloadId
                - txId
              type: object
              properties:
                notifType:
                  type: string
                  description: Key containing the type of notification
                  example: OK
                msgType:
                  type: string
                  description: Key containing the type of processed message (Pain.001, Pacs.008, Pacs.002, Pacs.004, Pacs.028, Camt.029, Camt.056)
                  example: pacs.008
                msgDirection:
                  type: string
                  description: Key containing the direction of the processed message
                  example: SND
                msgStatus:
                  type: string
                  description: Key containing the status of the processed message
                  example: '75000'
                msgStatusTmstp:
                  type: string
                  description: Key containing the timestamp of the MPH status
                  example: '2025-09-04 10:57:06.388+02:00'
                boStatus:
                  type: string
                  description: Key containing the Back-office status code
                boStatusTmstp:
                  type: string
                  description: Key containing the Back-office status timestamp.
                boStatusDesc:
                  type: string
                  description: Key containing the Back-office status description
                srvcNm:
                  type: string
                  description: Key containing the name of the service in case of KO notification
                srvcReasonCode:
                  type: string
                  description: Key containing the Reason code in case of KO notification
                payload:
                  type: string
                  description: Payload of the processed message to indicate for which the notification is sent
                  example: <?xml version="1.0" encoding="UTF-8" standalone="no"?><Document xmlns="urn:iso:std:iso:20022:tech:xsd:pacs.008.001.08"><FIToFICstmrCdtTrf><GrpHdr><msgIdentifier>msgIdentifier</msgIdentifier><CreDtTm>2023-12-19T12:35:37Z</CreDtTm><NbOfTxs>1</NbOfTxs><TtlIntrBkSttlmAmt Ccy="EUR">1.55</TtlIntrBkSttlmAmt><IntrBkSttlmDt>2024-01-31</IntrBkSttlmDt><SttlmInf><SttlmMtd>CLRG</SttlmMtd><ClrSys><Prtry>TIPS</Prtry></ClrSys></SttlmInf><PmtTpInf><SvcLvl><Cd>SEPA</Cd></SvcLvl><LclInstrIdentifierm><Cd>INST</Cd></LclInstrIdentifierm><CtgyPurp><Cd>PURP</Cd></CtgyPurp></PmtTpInf><InstgAgt><FinInstnId><BICFI>BNKAFRP0XXX</BICFI></FinInstnId></InstgAgt></GrpHdr><CdtTrfTxInf><PmtId><InstrIdentifierId>InstrIdentifierANAND</InstrIdentifierId><EndToEndId>eteIdentifier</EndToEndId><TxId>txIdentifier</TxId></PmtId><IntrBkSttlmAmt Ccy="EUR">1.55</IntrBkSttlmAmt><AccptncDtTm>2023-12-19T12:35:37.899+01:00</AccptncDtTm><ChrgBr>SLEV</ChrgBr><UltmtDbtr><Nm>Dr Sacha Da silva</Nm><Id><PrvtId><DtAndPlcOfBirth><BirthDt>1950-02-13</BirthDt><CityOfBirth>Mérignac</CityOfBirth><CtryOfBirth>FR</CtryOfBirth></DtAndPlcOfBirth>  </PrvtId></Id></UltmtDbtr><Dbtr><Nm>Mael Perrin</Nm>  <PstlAdr>  <Ctry>FR</Ctry><AdrLine>7 étage, 1113 Allée, Voie de Provence, 21483 Ivry-sur-Seine</AdrLine><AdrLine/></PstlAdr><Id><PrvtId><DtAndPlcOfBirth><BirthDt>1985-04-10</BirthDt><CityOfBirth>Montpellier</CityOfBirth><CtryOfBirth>FR</CtryOfBirth></DtAndPlcOfBirth></PrvtId></Id></Dbtr><DbtrAcct><Id><IBAN>FR891081183701QhV2I0ns12642</IBAN></Id></DbtrAcct><DbtrAgt><FinInstnId><BICFI>BNKAFRPRXXX</BICFI></FinInstnId></DbtrAgt><CdtrAgt><FinInstnId><BICFI>UFPOLT21XXX</BICFI></FinInstnId></CdtrAgt><Cdtr><Nm>Lucie Martinez</Nm><PstlAdr><Ctry>FR</Ctry><AdrLine>6 étage, 59 Place de la Victoire, 59930 Saint-Nazaire</AdrLine><AdrLine/></PstlAdr><Id><PrvtId><DtAndPlcOfBirth><BirthDt>2001-08-02</BirthDt><CityOfBirth>Antony</CityOfBirth><CtryOfBirth>FR</CtryOfBirth></DtAndPlcOfBirth></PrvtId></Id></Cdtr><CdtrAcct><Id><IBAN>FR203088913309NNV9Q3QedOF69</IBAN></Id></CdtrAcct><UltmtCdtr><Nm>Pons Léo</Nm><Id><PrvtId><DtAndPlcOfBirth><BirthDt>1985-10-26</BirthDt><CityOfBirth>Montauban</CityOfBirth><CtryOfBirth>FR</CtryOfBirth></DtAndPlcOfBirth></PrvtId></Id></UltmtCdtr><Purp><Cd>AAAA</Cd></Purp><RmtInf><Strd><CdtrRefInf><Tp><CdOrPrtry><Cd>SCOR</Cd></CdOrPrtry><Issr>CdtrRefInf_TypeIssuer</Issr></Tp><Ref>CdtrRefInf_Ref</Ref></CdtrRefInf></Strd></RmtInf></CdtTrfTxInf></FIToFICstmrCdtTrf></Document>
                confirmRptPayload:
                  type: string
                  description: Contains Payment Status Report payload for the processed message
                  example: <?xml version="1.0" encoding="UTF-8"?><tag0:Document xmlns:tag0="urn:iso:std:iso:20022:tech:xsd:pacs.002.001.10"><tag0:FIToFIPmtStsRpt><tag0:GrpHdr><tag0:msgIdentifier>R00202402011132257910003644</tag0:msgIdentifier><tag0:CreDtTm>2024-02-01T12:32:25Z</tag0:CreDtTm></tag0:GrpHdr><tag0:OrgnlGrpInfAndSts><tag0:OrgnlmsgIdentifier>msgIdentifier</tag0:OrgnlmsgIdentifier><tag0:OrgnlMsgNmId>pacs.008.001.08</tag0:OrgnlMsgNmId><tag0:GrpSts>ACCP</tag0:GrpSts></tag0:OrgnlGrpInfAndSts><tag0:TxInfAndSts><tag0:StsId>R00202402011132257910003644</tag0:StsId><tag0:OrgnlInstrIdentifierId>InstrIdentifierANAND</tag0:OrgnlInstrIdentifierId><tag0:OrgnlEndToEndId>eteIdentifier</tag0:OrgnlEndToEndId><tag0:OrgnlTxId>txId</tag0:OrgnlTxId><tag0:AccptncDtTm>2023-12-19T12:35:37.899+01:00</tag0:AccptncDtTm><tag0:OrgnlTxRef><tag0:PmtTpInf><tag0:SvcLvl><tag0:Cd>SEPA</tag0:Cd></tag0:SvcLvl><tag0:LclInstrIdentifierm><tag0:Cd>INST</tag0:Cd></tag0:LclInstrIdentifierm><tag0:CtgyPurp><tag0:Cd>PURP</tag0:Cd></tag0:CtgyPurp></tag0:PmtTpInf><tag0:DbtrAgt><tag0:FinInstnId><tag0:BICFI>BNKAFRPRXXX</tag0:BICFI></tag0:FinInstnId></tag0:DbtrAgt></tag0:OrgnlTxRef></tag0:TxInfAndSts></tag0:FIToFIPmtStsRpt></tag0:Document>
                confirmRptReasonCode:
                  type: string
                  description: Key containing the reason code extracted from the Payment Status Report/confirmation message Pain.002 or Pacs.002, if present
                payloadId:
                  type: string
                  description: Unique reference of the processed message related in the payload
                  example: txIdentifier
                txId:
                  type: string
                  description: Unique reference of original payment message
                  example: txIdentifier
                circuitCd:
                  type: string
                  description: The circuit on which the message is exchanged
                  example: TIPS
                bulkId:
                  type: string
                bankApp:
                  type: string
                  description: Name of the bank application issuing the payment if provided in the original message
                  example: bankAppName
                proprietary:
                  type: object
                  description: Key that allows to send a set of data specific to the Bank if provided in the original message
                  example: {"addressIP": "127.0.0.1","browser" : "IE11"}
                srvcJrnl:
                  type: array
                  description: Key combining the services execution informations
                  example:
                    - startTmStmp: '2024-02-01 12:32:25.218+01:00'
                      srvcNm: REACHABILITY
                      returnType: FORCED
                      returnCode: OK
                      endTmStmp: '2024-02-01 12:32:25.218+01:00'
                    - startTmStmp: '2024-02-01 12:32:25.228+01:00'
                      srvcNm: AMOUNT_CHECK
                      returnType: STANDARD
                      returnCode: OK
                      endTmStmp: '2024-02-01 12:32:25.228+01:00'
                  items:
                    required:
                      - endNanoTm
                      - endTmStmp
                      - returnCode
                      - returnType
                      - srvcNm
                      - srvcTp
                      - startNanoTm
                      - startTmStmp
                    type: object
                    properties:
                      startNanoTm:
                        type: string
                      startTmStmp:
                        type: string
                      msgStatus:
                        type: string
                      srvcNm:
                        type: string
                      srvcTp:
                        type: string
                      returnType:
                        type: string
                      returnCode:
                        type: string
                      reasonCode:
                        type: string
                      reasonLabel:
                        type: string
                      endNanoTm:
                        type: string
                      endTmStmp:
                        type: string
                      msgType:
                        type: string
                      msgDirection:
                        type: string
                    description: Key combining the services execution informations
                    example:
                      - startTmStmp: '2024-02-01 12:32:25.218+01:00'
                        srvcNm: REACHABILITY
                        srvcTp: Internal
                        returnType: FORCED
                        returnCode: OK
                        endTmStmp: '2024-02-01 12:32:25.218+01:00'
                      - startTmStmp: '2024-02-01 12:32:25.228+01:00'
                        srvcNm: AMOUNT_CHECK
                        srvcTp: Internal
                        returnType: STANDARD
                        returnCode: OK
                        endTmStmp: '2024-02-01 12:32:25.228+01:00'
           
                bulkInfo:
                  type: object
                  properties:
                    bulkInfoKeysList:
                      type: array
                      items:
                        type: object
                        properties:
                          msgNmId:
                            type: string
                          msgId:
                            type: string
                          pmtInfId:
                            type: string
                          instrId:
                            type: string
                          endToEndId:
                            type: string
                          pmtMtd:
                            type: string
                          svcLvlCd:
                            type: string
                          dbtrAcct:
                            type: string
                          cdtrAcct:
                            type: string
                          instdAmt:
                            type: string
        
        required: true
      responses:
        '200':
          description: Successfully validated
          content:
            application/json:
              schema:
                type: object
                properties:
                  returnCode:
                    maxLength: 3
                    minLength: 2
                    type: string
                    description: Key containing the return code. KO or OK.
                    example: OK
                  reasonCode:
                    maxLength: 30
                    minLength: 1
                    type: string
                    description: In case of error, reason code of what step raised the error
                    example: ''
                  reasonLabel:
                    type: string
                    description: Reason label associated with reason code
                    example: ''
                  errorCode:
                    type: string
                    description: Key containing the error code
                    example: ''
                  errorLabel:
                    type: string
                    description: Error label associated with error code
                    example: ''
              example:
                returnCode: OK
        '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