openapi: 3.0.1
info:
  title: Payment Capture API
  description: Payment Capture OpenAPI Specification
  version: 1.3.1
tags:
  - name: Payment Capture
    description: Payment capture endpoint
paths:
  /pain001:
    post:
      tags:
        - Payment Capture
      description: API for Capture pain001. From this endpoint, instance will take the submitted pain.001 payload and process it in realtime
      operationId: capturePainRequest
      requestBody:
        content:
          application/json:
            schema:
              required:
                - payload
                - suCd
              type: object
              properties:
                suCd:
                  type: string
                  description: Single Unit code of the payment owner.
                  example: BNKA
                payload:
                  type: string
                  description: Payload which contains pain.001 message.
                  example: <?xml version="1.0" encoding="UTF-8"?><Document xmlns="urn:iso:std:iso:20022:tech:xsd:pain.001.001.09" xmlns:xs="http://www.w3.org/2001/XMLSchema"><CstmrCdtTrfInitn><GrpHdr><MsgId>ABC/120928/CCT001</MsgId><CreDtTm>2012-09-28T14:07:00</CreDtTm><NbOfTxs>1</NbOfTxs><CtrlSum>115</CtrlSum><InitgPty><Nm>ABC Corporation</Nm><Id><OrgId><AnyBIC>BBBBFR33XXX</AnyBIC></OrgId></Id></InitgPty>>…
                circuitCd:
                  type: string
                  description: Expected Payments circuit code, used to bypass the reachability service.
                  example: TIPS
                bankApp:
                  type: string
                  description: Name of the bank application issuing the payment.
                  example: MobileBank
                forcedMode:
                  type: array
                  description: Grouping the services in forced mode. Expected results of client interface services call, used to bypass the client interface services
                  example:
                    - srvcNm: AUTH
                      returnCode: OK
                      reasonCode: '0000'
                      reasonLabel: No error
                    - srvcNm: SANCTION
                      returnCode: OK
                      reasonCode: '0000'
                      reasonLabel: No error
                  items:
                    required:
                      - reasonCode
                      - reasonLabel
                      - returnCode
                      - srvcNm
                    type: object
                    properties:
                      srvcNm:
                        type: string
                        description: The name of the forced service
                      returnCode:
                        type: string
                        description: Key that allows to force the return code
                      reasonCode:
                        type: string
                        description: Key that allows to force the Reason
                      reasonLabel:
                        type: string
                        description: Key that allows to force the Label
                    description: Grouping the services in forced mode. Expected results of client interface services call, used to bypass the client interface services
                    example:
                      - srvcNm: AUTH
                        returnCode: OK
                        reasonCode: '0000'
                        reasonLabel: No error
                      - srvcNm: SANCTION
                        returnCode: OK
                        reasonCode: '0000'
                        reasonLabel: No error
                proprietary:
                  type: object
                  description: Bank proprietary field, it allows to send a set of data specific to the Bank
                  example:
                    addressIP: 127.0.0.1
                    browser: IE11
        required: true
      responses:
        '201':
          description: Successfully created
          content:
            application/json:
              schema:
                required:
                  - returnCode
                type: object
                properties:
                  returnCode:
                    maxLength: 2
                    minLength: 2
                    type: string
                    description: Return code OK or KO.
                    example: OK
                  reasonCode:
                    maxLength: 30
                    minLength: 1
                    type: string
                    description: In the event of an error, reason code of what step raised the error
                    example: ''
                  reasonLabel:
                    type: string
                    description: In the event of an error, List of Reason label associated with reason code.
                    example: ''
                  processName:
                    type: string
                    description: In the event of an error, the name of the process that caused the error.
                    example: ''
        '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
  /pacs008:
    post:
      tags:
        - Payment Capture
      description: API for Capture pacs008. From this endpoint, instance will take the submitted pacs.008 payload and process it in realtime
      operationId: capturePacsRequest
      requestBody:
        content:
          application/json:
            schema:
              required:
                - payload
                - suCd
              type: object
              properties:
                suCd:
                  type: string
                  description: Single Unit code of the payment owner.
                  example: BNKA
                payload:
                  type: string
                  description: Payload which contains pacs.008 message.
                  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><MsgId>EP8-01RT1-P2R-P8E-10-131111459</MsgId><CreDtTm>2023-05-12T11:14:59Z</CreDtTm><NbOfTxs>000000000000001</NbOfTxs><TtlIntrBkSttlmAmt Ccy="EUR">12793.15</TtlIntrBkSttlmAmt><IntrBkSttlmDt>2023-05-12</IntrBkSttlmDt><SttlmInf><SttlmMtd>CLRG</SttlmMtd><ClrSys><Prtry>RT1</Prtry></ClrSys></SttlmInf><PmtTpInf><SvcLvl><Cd>SEPA</Cd></SvcLvl><LclInstrm><Cd>INST</Cd></LclInstrm><CtgyPurp><Cd>TAXS</Cd></CtgyPurp></PmtTpInf><InstgAgt><FinInstnId><BIC>BREDFRPP</BIC></FinInstnId></InstgAgt><InstdAgt><FinInstnId><BIC>IPSTFRPP</BIC></FinInstnId></GrpHdr>…
                circuitCd:
                  type: string
                  description: Expected Payments circuit code, used to bypass the reachability service.
                  example: TIPS
                bankApp:
                  type: string
                  description: Name of the bank application issuing the payment.
                  example: MobileBank
                forcedMode:
                  type: array
                  description: Grouping the services in forced mode. Expected results of client interface services call, used to bypass the client interface services
                  example:
                    - srvcNm: AUTH
                      returnCode: OK
                      reasonCode: '0000'
                      reasonLabel: No error
                    - srvcNm: SANCTION
                      returnCode: OK
                      reasonCode: '0000'
                      reasonLabel: No error
                  items:
                    required:
                      - reasonCode
                      - reasonLabel
                      - returnCode
                      - srvcNm
                    type: object
                    properties:
                      srvcNm:
                        type: string
                        description: The name of the forced service
                      returnCode:
                        type: string
                        description: Key that allows to force the return code
                      reasonCode:
                        type: string
                        description: Key that allows to force the Reason
                      reasonLabel:
                        type: string
                        description: Key that allows to force the Label
                    description: Grouping the services in forced mode. Expected results of client interface services call, used to bypass the client interface services
                    example:
                      - srvcNm: AUTH
                        returnCode: OK
                        reasonCode: '0000'
                        reasonLabel: No error
                      - srvcNm: SANCTION
                        returnCode: OK
                        reasonCode: '0000'
                        reasonLabel: No error
                proprietary:
                  type: object
                  description: Bank proprietary field, it allows to send a set of data specific to the Bank
                  example:
                    addressIP: 127.0.0.1
                    browser: IE11
                bulkId:
                  type: string
                  description: Identifier of the parent bulk of the pacs.008
                bulkInfo:
                  type: object
                  description: Detailed information of the parent bulk of the pacs.008, free input
        required: true
      responses:
        '201':
          description: Successfully created
          content:
            application/json:
              schema:
                required:
                  - returnCode
                type: object
                properties:
                  returnCode:
                    maxLength: 2
                    minLength: 2
                    type: string
                    description: Return code OK or KO.
                    example: OK
                  reasonCode:
                    maxLength: 30
                    minLength: 1
                    type: string
                    description: In the event of an error, reason code of what step raised the error
                    example: ''
                  reasonLabel:
                    type: string
                    description: In the event of an error, List of Reason label associated with reason code.
                    example: ''
                  processName:
                    type: string
                    description: In the event of an error, the name of the process that caused the error.
                    example: ''
        '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