Gateway Technical Documentation

Communication Test

Heartbeat service

GET [base-url]/gateway/api/heartbeat

With heartbeat it's possible to test if system is up and connection certificate is configured correctly. If configured correctly, it returns current system time. One should use for testing some API testing tool (Postman, SOAP UI, cURL). Sample statements is in code box below. Your PEM certificate should be put instead yourcert.crt and yourkey.key should be replaced with key files. If you have certificate with password, you should add password in the curl command after certificate's name yourcert.crt:password

// Sandbox:
 curl -X GET "https://cpgw-sandbox.cooppank.ee/gateway/api/heartbeat" --cert yourcert.crt --key yourkey.key


 // Live:
 curl -X GET "https://cpgw.cooppank.ee/gateway/api/heartbeat" --cert yourcert.crt --key yourkey.key


 // Sandbox - for service providers:
 curl -X GET "https://cpgw-sandbox.cooppank.ee/gateway/api/heartbeat" --cert yourcert.crt --key yourkey.key -H "Client-Code: 012345678" -H "Client-Country: EE"


 // Live - for service providers:
 curl -X GET "https://cpgw.cooppank.ee/gateway/api/heartbeat" --cert yourcert.crt --key yourkey.key -H "Client-Code: 012345678" -H "Client-Country: EE"

Sample response

<HeartBeatResponse>
  <TimeStamp>2022-08-19T15:06:07.141</TimeStamp>
  <AuthorizedUser/>
  <UserRequest/>
</HeartBeatResponse>

GET [base-url]/gateway/api/heartbeat/mq

It's the same as GET /heartbeat, but the response message will be created in the queue and could be read with GET/messagest/next. Response includes additional user information. This service can be used for simulating the general messaging logic without more complex Account Information or Payments requests.

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<HeartBeatResponse>
  <TimeStamp>2022-08-22T13:22:00.007</TimeStamp>
  <AuthorizedUser>
    <Name>Test user</Name>
    <Code>12345678</Code>
  </AuthorizedUser>
  <UserRequest>
    <Content>test</Content>
  </UserRequest>
</HeartBeatResponse>

POST [base-url]/gateway/api/heartbeat

This service can be used for testing the ASICE and BDOC requests.

Request must contain digitally signed request.xml file, saved in ASICE or BDOC. Service takes authenticated user info, extracts ASICE or BDOC signature data and request.xml content and creates response xml like shown below.

One can read the response via messaging service GET " https://cpgw-sandbox.cooppank.ee/gateway/api/messages/next ".

Sample response

<?xml version="1.0" encoding="UTF-8"?>
<HeartBeatResponse>
  <TimeStamp>2022-08-22T13:34:25.007</TimeStamp>
  <AuthorizedUser>
    <Name>Test user</Name>
    <Code>12345678</Code>
  </AuthorizedUser>
  <Signatures>
    <Signature>
      <Name>Coop Pank</Name>
      <Code>12345678</Code>
    </Signature>
  </Signatures>
  <UserRequest>
    <xml></xml>
  </UserRequest>
</HeartBeatResponse>

Request Account Report

Account Statement

POST [base-url]/gateway/api/account-statement

Account Statement is used when statement end-date is in the past and it is used to report booked transactions and balances.
With Account Statement one receive the list of transactions, both incoming and outgoing, also payments with added details. Request can be made for the given period for one Customer Account.
For this endpoint the max amount of requests per hour apply - max 10 requests in an hour per every client (not per account).

For Account Statement and Automatic Account Statement message, it is possible to order the digital stamp of Coop Pank, see more details Digital stamp of Coop Pank.

Account Balance

POST [base-url]/gateway/api/account-balance

Account Balance is used for current day statement and it reports intraday transactions and balances (actual and free balance for all the currencies used). Balances are provided real-time on the moment of generating the response. Request can be made for one Customer Account at once.
To request Payment limits info, one can use optional Prtry parameter. Both total and free limits for Daily and Monthly periods are received.
For this endpoint the max amount of requests per hour apply - max 10 requests in an hour per every client (not per account).

XML format (camt.060.001.06)

This description is related to the ISO 20022 Account Report Request camt.060.001.06 XML-based description, which will replace the proprietary electronic account reporting standards used by banks operating in Estonia. One can use it for both Account Statement and Account Balance requests.

The AccountReportingRequest message is sent by the account owner, either directly or through a forwarding agent, to one of its account servicing institutions. It is used to ask the account servicing institution to send a report on the account owner's account in a BankToCustomerAccountReport.
Some values apply for both services and some are specific to either Statements or Balances response only.

Request's Content-Type has to be 'multipart/form-data' and it has to contain XML file in "request" position, with its type also defined as "text/xml".

Example how to create Account Statement Request with Java Apache HttpClient

String xml = """
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.060.001.06">
  <AcctRptgReq>
    <GrpHdr>
      <MsgId>20230201171147610</MsgId>
      <CreDtTm>2023-01-02T17:11:47.610+02:00</CreDtTm>
    </GrpHdr>
    <RptgReq>
      <Id>20230201171147610</Id>
      <ReqdMsgNmId>camt.052.001.02</ReqdMsgNmId>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
      </Acct>
      <AcctOwnr>
        <Pty/>
      </AcctOwnr>
      <RptgPrd>
        <FrToDt>
          <FrDt>2023-01-01</FrDt>
          <ToDt>2023-01-01</ToDt>
        </FrToDt>
        <Tp>ALLL</Tp>
      </RptgPrd>
    </RptgReq>
  </AcctRptgReq>
</Document>
""";

try (CloseableHttpClient client = HttpClients.createDefault()) {
  HttpPost request = new HttpPost(gatewayUri + "/account-statement");
  request.setEntity(MultipartEntityBuilder.create()
  .addBinaryBody("request", xml.getBytes(), ContentType.create("text/xml"), "request")
  .setLaxMode()
  .build());
  client.execute(request);
}

catch (IOException ex) {
  
  ...
}

Message root

Group header

Sample

Account Statement

This is sample request for the account statement for account EE214204200000000000.

Parameters used

• The period: 31th of August 2022, time.

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.060.001.06">
  <AcctRptgReq>
    <GrpHdr>
      <MsgId>MSGIDCOOPPANKTEST01</MsgId>
      <CreDtTm>2022-08-31T16:15:07.617</CreDtTm>
    </GrpHdr>
    <RptgReq>
      <ReqdMsgNmId>camt.053.001.02</ReqdMsgNmId>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
      </Acct>
      <AcctOwnr>
        <Pty/>
      </AcctOwnr>
      <RptgPrd>
        <FrToDt>
          <FrDt>2022-08-31</FrDt>
          <ToDt>2022-08-31</ToDt>
        </FrToDt>
        <Tp>ALLL</Tp>
      </RptgPrd>
      <ReqdBalTp>
        <CdOrPrtry>
          <Prtry>DATE</Prtry>
        </CdOrPrtry>
      </ReqdBalTp>
    </RptgReq>
  </AcctRptgReq>
</Document>

Account Balance

This is sample request for the account statement for account EE214204200000000000

Parameters used

• Balances are taken from current date, therefore it's not necessary to use Date parameters

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.060.001.06">
  <AcctRptgReq>
    <GrpHdr>
      <MsgId>MSGIDCOOPPANKTEST01</MsgId>
      <CreDtTm>2022-08-30T16:15:07.617</CreDtTm>
    </GrpHdr>
    <RptgReq>
      <ReqdMsgNmId>camt.052.001.02</ReqdMsgNmId>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
      </Acct>
      <AcctOwnr>
        <Pty/>
      </AcctOwnr>
      <RptgPrd>
        <FrToDt>
          <FrDt>2022-08-30</FrDt>
          <ToDt>2022-08-30</ToDt>
        </FrToDt>
        <Tp>ALLL</Tp>
      </RptgPrd>
    </RptgReq>
  </AcctRptgReq>
</Document>

Error codes

Response Account Balance

XML format (ISO 20022 Account Report Message camt.052.001.06)

The ISO 20022 Account Report Message camt.052.001.06 is used for current day balances. Two balances are returned: the actual booked balance without reservations and the actual available balance with reservations. If the current balance is 0 EUR, then it's returned so.

Rate limit - max amount of requests is 10 per hour for each client (not per account).

Header Message-Response-Type: ACCOUNT_BALANCE

Message structure

Group Header - mandatory, occurs once.
Report - mandatory and repetitive per currency. Includes one to many Balance blocks.

Message root

Group header

Report

Sample of Account Balance

Sample account EE214204200000000000 has two balances in EUR (current available and current booked balance).

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.052.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.052.001.02 camt.052.001.02.xsd">
  <BkToCstmrAcctRpt>
    <GrpHdr>
      <MsgId>22092212431044624</MsgId>
      <CreDtTm>2022-09-22T12:43:10.209+03:00</CreDtTm>
    </GrpHdr>
    <Rpt>
      <Id>22092212431044624EUR</Id>
      <CreDtTm>2022-09-22T12:43:10.209+03:00</CreDtTm>
      <FrToDt>
        <FrDtTm>2022-09-22T12:43:10.209+03:00</FrDtTm>
        <ToDtTm>2022-09-22T12:43:10.209+03:00</ToDtTm>
      </FrToDt>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
        <Ccy>EUR</Ccy>
      </Acct>
      <Bal>
        <Tp>
          <CdOrPrtry>
            <Cd>ITBD</Cd>
          </CdOrPrtry>
        </Tp>
        <Amt Ccy="EUR">991946579.49</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Dt>
          <Dt>2022-09-22</Dt>
        </Dt>
      </Bal>
      <Bal>
        <Tp>
          <CdOrPrtry>
            <Cd>ITAV</Cd>
          </CdOrPrtry>
        </Tp>
        <Amt Ccy="EUR">991949579.49</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Dt>
          <Dt>2022-09-22</Dt>
        </Dt>
      </Bal>
    </Rpt>
  </BkToCstmrAcctRpt>
</Document>

Response Account Statement

XML format (ISO 20022 Account Statement Message camt.053.001.02)

CAMT.053.001.02 is used when statement end-date is in the past and it is used to report booked transactions and balances. Information about the opening balance, the closing balance, and the available balance with all booked transactions of a specified period is included in the message.
It's possible to make a request up to 7 years and 5 days old data.

Header Message-Response-Type: ACCOUNT_STATEMENT

Message structure

Group Header – mandatory, presented once.
Statement – mandatory and repetitive. It should be repeated for each account on which a statement is provided.
Balance – mandatory and repetitive. Contains elements such as Opening Booked Balance and Closing Booked Balance.
Entry – included in the Statement block. Contains information related to an entry on the account.
Entry Details – included in the Entry block. Contains detailed information related to the entry

Message root

Statement

Sample of Account Statement

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02 camt.053.001.02.xsd">
  <BkToCstmrStmt>
    <GrpHdr>
      <MsgId>24090106573025982</MsgId>
      <CreDtTm>2024-09-01T06:57:30.475+03:00</CreDtTm>
      <MsgPgntn>
        <PgNb>1</PgNb>
        <LastPgInd>true</LastPgInd>
      </MsgPgntn>
    </GrpHdr>
    <Stmt>
      <Id>24090106573025982EUR</Id>
      <ElctrncSeqNb>1</ElctrncSeqNb>
      <CreDtTm>2024-09-01T06:57:30.475+03:00</CreDtTm>
      <FrToDt>
        <FrDtTm>2024-08-31T00:00:00.000+03:00</FrDtTm>
        <ToDtTm>2024-08-31T23:59:59.000+03:00</ToDtTm>
      </FrToDt>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
        <Ccy>EUR</Ccy>
        <Ownr>
          <Nm>TEST OÜ</Nm>
          <Id>
            <OrgId>
              <Othr>
                <Id>11111111</Id>
              </Othr>
            </OrgId>
          </Id>
        </Ownr>
        <Svcr>
          <FinInstnId>
            <BIC>EKRDEE22</BIC>
            <Nm>Coop Pank AS</Nm>
            <PstlAdr>
              <AdrTp>BIZZ</AdrTp>
              <StrtNm>Maakri</StrtNm>
              <BldgNb>30</BldgNb>
              <PstCd>15014</PstCd>
              <TwnNm>Tallinn</TwnNm>
              <CtrySubDvsn>Harjumaa</CtrySubDvsn>
              <Ctry>EE</Ctry>
            </PstlAdr>
          </FinInstnId>
        </Svcr>
      </Acct>
      <Bal>
        <Tp>
          <CdOrPrtry>
            <Cd>OPBD</Cd>
          </CdOrPrtry>
        </Tp>
        <Amt Ccy="EUR">30000.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Dt>
          <Dt>2024-08-31</Dt>
        </Dt>
      </Bal>
      <Bal>
        <Tp>
          <CdOrPrtry>
            <Cd>CLBD</Cd>
          </CdOrPrtry>
        </Tp>
        <Amt Ccy="EUR">33515.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Dt>
          <Dt>2024-08-31</Dt>
        </Dt>
      </Bal>
      <TxsSummry>
        <TtlCdtNtries>
          <NbOfNtries>3</NbOfNtries>
          <Sum>3520.00</Sum>
        </TtlCdtNtries>
        <TtlDbtNtries>
          <NbOfNtries>1</NbOfNtries>
          <Sum>5.00</Sum>
        </TtlDbtNtries>
      </TxsSummry>
      <Ntry>
        <NtryRef>1</NtryRef>
        <Amt Ccy="EUR">3000.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2024-08-31</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2024-08-31</Dt>
        </ValDt>
        <AcctSvcrRef>1144C103-530879555</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>RCDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>1144C103-530879555</AcctSvcrRef>
              <InstrId>123</InstrId>
              <TxId>1144C103</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">3000.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Nm>MARI MAASIKAS</Nm>
                <Id>
                  <PrvtId>
                    <Othr>
                      <Id>48603106511</Id>
                      <SchmeNm>
                        <Prtry>NIDN</Prtry>
                      </SchmeNm>
                    </Othr>
                  </PrvtId>
                </Id>
              </Dbtr>
              <DbtrAcct>
                <Id>
                  <IBAN>EE584204200000000011</IBAN>
                </Id>
              </DbtrAcct>
            </RltdPties>
            <RltdAgts>
              <DbtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>Coop Pank AS</Nm>
                </FinInstnId>
              </DbtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>Laekumine testimiseks 1</Ustrd>
              <Strd>
                <CdtrRefInf>
                  <Ref>1234567891</Ref>
                </CdtrRefInf>
              </Strd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
      <Ntry>
        <NtryRef>2</NtryRef>
        <Amt Ccy="EUR">500.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2024-08-31</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2024-08-31</Dt>
        </ValDt>
        <AcctSvcrRef>1146660B-531051111</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>RCDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>1146660B-531051111</AcctSvcrRef>
              <InstrId>1234</InstrId>
              <TxId>1146660B</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">500.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Nm>JAAK-KRISTJAN JÕEORG</Nm>
                <Id>
                  <PrvtId>
                    <Othr>
                      <Id>38001085718</Id>
                      <SchmeNm>
                        <Prtry>NIDN</Prtry>
                      </SchmeNm>
                    </Othr>
                  </PrvtId>
                </Id>
              </Dbtr>
              <DbtrAcct>
                <Id>
                  <IBAN>EE584204200000000012</IBAN>
                </Id>
              </DbtrAcct>
            </RltdPties>
            <RltdAgts>
              <DbtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>Coop Pank AS</Nm>
                </FinInstnId>
              </DbtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>Laekumine testimiseks 2</Ustrd>
              <Strd>
                <CdtrRefInf>
                  <Ref>1234567892</Ref>
                </CdtrRefInf>
              </Strd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
      <Ntry>
        <NtryRef>3</NtryRef>
        <Amt Ccy="EUR">20.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2024-08-31</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2024-08-31</Dt>
        </ValDt>
        <AcctSvcrRef>11444A60-531054700</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>RCDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>11444A60-5310547030</AcctSvcrRef>
              <InstrId>12345</InstrId>
              <TxId>11444A60</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">20.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Nm>TESTIMISEKS AS</Nm>
                <Id>
                  <PrvtId>
                    <Othr>
                      <Id>11111111</Id>
                      <SchmeNm>
                        <Prtry>NIDN</Prtry>
                      </SchmeNm>
                    </Othr>
                  </PrvtId>
                </Id>
              </Dbtr>
              <DbtrAcct>
                <Id>
                  <IBAN>EE584204200000000013</IBAN>
                </Id>
              </DbtrAcct>
            </RltdPties>
            <RltdAgts>
              <DbtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>Coop Pank AS</Nm>
                </FinInstnId>
              </DbtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>Laekumine testimiseks 3</Ustrd>
              <Strd>
                <CdtrRefInf>
                  <Ref>1234567893</Ref>
                </CdtrRefInf>
              </Strd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
      <Ntry>
        <NtryRef>4</NtryRef>
        <Amt Ccy="EUR">5.00</Amt>
        <CdtDbtInd>DBIT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2024-08-31</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2024-08-31</Dt>
        </ValDt>
        <AcctSvcrRef>561C0D0</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>ICDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>561C0D0</AcctSvcrRef>
              <InstrId>123456</InstrId>
              <TxId>561C0D0</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">5.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Id>
                  <OrgId>
                    <Othr>
                      <Id>1111111</Id>
                      <SchmeNm>
                        <Prtry>COID</Prtry>
                      </SchmeNm>
                    </Othr>
                  </OrgId>
                </Id>
              </Dbtr>
              <Cdtr>
                <Nm>TEST OÜ</Nm>
              </Cdtr>
              <CdtrAcct>
                <Id>
                  <IBAN>EE214204200000000000</IBAN>
                </Id>
              </CdtrAcct>
            </RltdPties>
            <RltdAgts>
              <CdtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>Coop Pank AS</Nm>
                </FinInstnId>
              </CdtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>Makse testimiseks 1</Ustrd>
              <Strd>
                <CdtrRefInf>
                  <Ref>1234567894</Ref>
                </CdtrRefInf>
              </Strd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
    </Stmt>
  </BkToCstmrStmt>
</Document>

For long account statements containing larger number of transactions pagination can be used - one Account Statement response receives more than one response in the queue. Currently the pagination limit per message is 10 000 transactions. Total amount of transactions in any response is 100 000 - in 10 separate response messages. Layout of first message header:

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02 camt.053.001.02.xsd">
  <BkToCstmrStmt>
    <GrpHdr>
      <MsgId>24090106573025982</MsgId>
      <CreDtTm>2024-09-01T06:57:30.475+03:000</CreDtTm>
      <MsgPgntn>
        <PgNb>1</PgNb>
        <LastPgInd>false</LastPgInd>
      </MsgPgntn>
    </GrpHdr>
  </BkToCstmrStmt>
</Document>

Layout of second and final message header:

<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02 camt.053.001.02.xsd">
  <Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02 camt.053.001.02.xsd">
    <BkToCstmrStmt>
      <GrpHdr>
        <MsgId>24090106573025982</MsgId>
        <CreDtTm>2024-09-01T06:57:30.475+03:00</CreDtTm>
        <MsgPgntn>
          <PgNb>2</PgNb>
          <LastPgInd>true</LastPgInd>
        </MsgPgntn>
      </GrpHdr>
    </BkToCstmrStmt>
  </Document>
</Document>

Debit Credit Notification

XML format (ISO 20022 Bank To Customer Debit Credit Notification camt.054.001.02)

CAMT.054.001.02 Bank To Customer Debit Credit Notification is used to report single booked entry. The customer can recieve either debit or credit notifications or both, depending on the contract.
No balance information is included.

Header Message-Response-Type: CREDIT_DEBIT_NOTIFICATION

Message structure

Debit Credit Notification message does not include the Message-Request-Id HTTP header!

Group Header – mandatory, preseneted once.
Notificaton – required for every account and currency. Repetitive per account number and currency. One notification block can include many entries.
Entry – optional and repetitive. Contains information about single entry.

Elements

Sample of debit notification

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.054.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.054.001.02 camt.054.001.02.xsd">
  <BkToCstmrDbtCdtNtfctn>
    <GrpHdr>
      <MsgId>MSGID_20220922111310_531549</MsgId>
      <CreDtTm>2022-09-22T11:13:10.825+03:00</CreDtTm>
    </GrpHdr>
    <Ntfctn>
      <Id>EE214204200000000000EUR20220922</Id>
      <ElctrncSeqNb>1</ElctrncSeqNb>
      <CreDtTm>2022-09-22T11:13:10.825+03:00</CreDtTm>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
        <Ccy>EUR</Ccy>
        <Ownr>
          <Nm>Testimiseks OÜ</Nm>
          <Id>
            <OrgId>
              <Othr>
                <Id>123412</Id>
              </Othr>
            </OrgId>
          </Id>
        </Ownr>
        <Svcr>
          <FinInstnId>
            <BIC>EKRDEE22</BIC>
            <Nm>COOP PANK AS</Nm>
            <PstlAdr>
              <AdrTp>BIZZ</AdrTp>
              <StrtNm>Maakri</StrtNm>
              <BldgNb>30</BldgNb>
              <PstCd>15014</PstCd>
              <TwnNm>Tallinn</TwnNm>
              <CtrySubDvsn>Harjumaa</CtrySubDvsn>
              <Ctry>EE</Ctry>
            </PstlAdr>
          </FinInstnId>
        </Svcr>
      </Acct>
      <TxsSummry>
        <TtlCdtNtries>
          <NbOfNtries>0</NbOfNtries>
          <Sum>0.00</Sum>
        </TtlCdtNtries>
        <TtlDbtNtries>
          <NbOfNtries>1</NbOfNtries>
          <Sum>25.00</Sum>
        </TtlDbtNtries>
      </TxsSummry>
      <Ntry>
        <NtryRef>1</NtryRef>
        <Amt Ccy="EUR">25.00</Amt>
        <CdtDbtInd>DBIT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2022-09-22</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2022-09-22</Dt>
        </ValDt>
        <AcctSvcrRef>71B2EA2</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>ICDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>71B2EA2</AcctSvcrRef>
              <InstrId>168</InstrId>
              <TxId>71B2EA2</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">25.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Id>
                  <OrgId>
                    <Othr>
                      <Id>123412</Id>
                      <SchmeNm>
                        <Prtry>COID</Prtry>
                      </SchmeNm>
                    </Othr>
                  </OrgId>
                </Id>
              </Dbtr>
              <Cdtr>
                <Nm>XXXXX OÜ</Nm>
                <Id>
                  <PrvtId>
                    <Othr>
                      <Id>16166605</Id>
                    </Othr>
                  </PrvtId>
                </Id>
              </Cdtr>
              <CdtrAcct>
                <Id>
                  <IBAN>EE584204200000000013</IBAN>
                </Id>
              </CdtrAcct>
            </RltdPties>
            <RltdAgts>
              <CdtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>COOP PANK</Nm>
                </FinInstnId>
              </CdtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>testimiseks</Ustrd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
    </Ntfctn>
  </BkToCstmrDbtCdtNtfctn>
</Document>

Sample of credit notification

<?xml version="1.0" encoding="UTF-8"?>
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:camt.054.001.02" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="urn:iso:std:iso:20022:tech:xsd:camt.054.001.02 camt.054.001.02.xsd">
  <BkToCstmrDbtCdtNtfctn>
    <GrpHdr>
      <MsgId>MSGID_20220922111311_419562</MsgId>
      <CreDtTm>2022-09-22T11:13:11.254+03:00</CreDtTm>
    </GrpHdr>
    <Ntfctn>
      <Id>EE214204200000000000EUR20220922</Id>
      <ElctrncSeqNb>1</ElctrncSeqNb>
      <CreDtTm>2022-09-22T11:13:11.254+03:00</CreDtTm>
      <Acct>
        <Id>
          <IBAN>EE214204200000000000</IBAN>
        </Id>
        <Ccy>EUR</Ccy>
        <Ownr>
          <Nm>XXXX OÜ</Nm>
          <Id>
            <OrgId>
              <Othr>
                <Id>16166605</Id>
              </Othr>
            </OrgId>
          </Id>
        </Ownr>
        <Svcr>
          <FinInstnId>
            <BIC>EKRDEE22</BIC>
            <Nm>COOP PANK AS</Nm>
            <PstlAdr>
              <AdrTp>BIZZ</AdrTp>
              <StrtNm>Maakri</StrtNm>
              <BldgNb>30</BldgNb>
              <PstCd>15014</PstCd>
              <TwnNm>Tallinn</TwnNm>
              <CtrySubDvsn>Harjumaa</CtrySubDvsn>
              <Ctry>EE</Ctry>
            </PstlAdr>
          </FinInstnId>
        </Svcr>
      </Acct>
      <TxsSummry>
        <TtlCdtNtries>
          <NbOfNtries>1</NbOfNtries>
          <Sum>25.00</Sum>
        </TtlCdtNtries>
        <TtlDbtNtries>
          <NbOfNtries>0</NbOfNtries>
          <Sum>0.00</Sum>
        </TtlDbtNtries>
      </TxsSummry>
      <Ntry>
        <NtryRef>1</NtryRef>
        <Amt Ccy="EUR">25.00</Amt>
        <CdtDbtInd>CRDT</CdtDbtInd>
        <Sts>BOOK</Sts>
        <BookgDt>
          <Dt>2022-09-22</Dt>
        </BookgDt>
        <ValDt>
          <Dt>2022-09-22</Dt>
        </ValDt>
        <AcctSvcrRef>71B2EA2</AcctSvcrRef>
        <BkTxCd>
          <Domn>
            <Cd>PMNT</Cd>
            <Fmly>
              <Cd>RCDT</Cd>
              <SubFmlyCd>BOOK</SubFmlyCd>
            </Fmly>
          </Domn>
        </BkTxCd>
        <NtryDtls>
          <TxDtls>
            <Refs>
              <AcctSvcrRef>71B2EA2</AcctSvcrRef>
              <InstrId>168</InstrId>
              <TxId>71B2EA2</TxId>
            </Refs>
            <AmtDtls>
              <TxAmt>
                <Amt Ccy="EUR">25.00</Amt>
              </TxAmt>
            </AmtDtls>
            <RltdPties>
              <Dbtr>
                <Nm>Testimiseks OÜ</Nm>
                <Id>
                  <OrgId>
                    <Othr>
                      <Id>123412</Id>
                      <SchmeNm>
                        <Prtry>COID</Prtry>
                      </SchmeNm>
                    </Othr>
                  </OrgId>
                </Id>
              </Dbtr>
              <DbtrAcct>
                <Id>
                  <IBAN>EE954204200000000026</IBAN>
                </Id>
              </DbtrAcct>
            </RltdPties>
            <RltdAgts>
              <DbtrAgt>
                <FinInstnId>
                  <BIC>EKRDEE22</BIC>
                  <Nm>COOP PANK</Nm>
                </FinInstnId>
              </DbtrAgt>
            </RltdAgts>
            <RmtInf>
              <Ustrd>testimiseks</Ustrd>
            </RmtInf>
          </TxDtls>
        </NtryDtls>
      </Ntry>
    </Ntfctn>
  </BkToCstmrDbtCdtNtfctn>
</Document>

Sandbox

Debit and/or Credit Notifications can be tested in Sandbox environment.

Debit Notification in Sandbox

Purpose

Debit Notification message informs the account holder of the debit entry or transaction that has been applied to their account. Debit Notification message is sent as a response message to Payment Initiation Request. Debit Notification message in Sandbox environment is composed independently of other services (e.g. Account Statement, Account Balance etc.), meaning that Debit Notification's transactions are sample transactions that are not reflected in other types of messages.

Description

A Debit Notification example message will be returned as a response message to Payment Initiation Request. However, the availability of the notification depends on the specific services included in the Coop Pank Gateway contract.

Dynamic Value Replacement

When Debit Notification is generated, certain dynamic values within the message are replaced. These dynamic elements include:

• <CreDtTm>: Located at <BkToCstmrDbtCdtNtfctn> → <GrpHdr> → <CreDtTm>. Created based on the date and time of message creation according to Tallinn time zone.
• <CreDtTm>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <CreDtTm>. Created based on the date and time of message creation according to Tallinn time zone.
• <IBAN>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Acct> → <Id> → <IBAN>. Replaced based on the debtor account from the incoming Payment Initiation XML.
• <Nm>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Acct> → <Ownr> → <Nm>. Replaced based on the debtor name from the incoming Payment Initiation XML.
• <Amt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <Amt>. Replaced based on the instructed transaction amount from the incoming Payment Initiation XML.
• <Amt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <AmtDtls> → <InstdAmt> → <Amt>. Replaced based on the instructed transaction amount from the incoming Payment Initiation XML.
• <Amt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <AmtDtls> → <TxAmt> → <Amt>. Replaced based on the instructed transaction amount from the incoming Payment Initiation XML.
• <Dt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <BookgDt> → <Dt>. Created based on the date of message creation according to Tallinn time zone.
• <InstrId>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <Refs> → <InstrId>. Replaced based on the instruction identification from the incoming Payment Initiation XML.
• <Nm>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <RltdPties> → <Cdtr> → <Nm>. Replaced based on the creditor name from the incoming Payment Initiation XML.
• <IBAN>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <RltdPties> → <CdtrAcct> → <Id> → <IBAN>. Replaced based on the creditor account from the incoming Payment Initiation XML.

Notes

• Debit Notification will be returned as a response message to Payment Initiation Request. However, the availability of the notification depends on the specific services included in the Coop Pank Gateway contract.
• Debit Notification has following transaction code structure, independent of the payment type specified in the incoming Payment Initiation XML:
• Domain Code: "PMT" (Payment)
• Family Code: "ICDT" (Issued Credit Transfer)
• Subfamily Code: "OTHR" (Other)
• Debit Notification has certain dynamic values that are replaced in the message. Some of the values are replaced based on the incoming Payment Initiation XML.
• In case there are multiple transactions in the Payment Initiation XML, dynamic values will be replaced based on the last transaction in the file.

Credit Notification in Sandbox

Purpose

Credit Notification message informs the account holder of the incoming funds. For testing purposes in Sandbox, Credit Notification message is sent as a response message to Payment Initiation Request, so that it can be managed through Payment Initiation Request what type of Credit Notification message example is received. Credit Notification message in Sandbox environment is composed independently of other services (e.g. Account Statement, Account Balance etc.), meaning that Credit Notification's transactions are sample transactions that are not reflected in other types of messages. Credit Notification message examples in Sandbox:

• Incoming intrabank payment;
• Incoming Estonian payment (Swedbank);
• Incoming European payment (from a Latvian bank);
• Conversion transaction (incoming payment in SEK into an account in EUR);
• Receipt of interest;
• Cash deposit at branch;
• Cash deposit at branch with service fee (the amount exceeds the free cash deposit limit);
• Cash deposit at Coop store.

Description

A Credit Notification example message will be returned as a response message to Payment Initiation Request only if <Ustrd> element in the Payment Initiation XML contains one of the specified values. A specific example message is retrieved based on the value provided in the <Ustrd> element in the Payment Initiation XML, which is located within <CstmrCdtTrfInitn> (CustomerCreditTransferInitiation) section of the XML message structure, specifically under <PmtInf> (PaymentInformation) → <CdtTrfTxInf> (CreditTransferTransactionInformation) → <RmtInf> (RemittanceInformation).

The <Ustrd> element should be set to one of the following values to receive corresponding Credit Notification example message:

• "CAMT.054.CN.DEMO1" to receive an example message for incoming intrabank payment;
• "CAMT.054.CN.DEMO2" to receive an example message for incoming Estonian payment (Swedbank);
• "CAMT.054.CN.DEMO3" to receive an example message for incoming European payment (from a Latvian bank);
• "CAMT.054.CN.DEMO4" to receive an example message for conversion transaction (incoming payment in SEK into an account in EUR);
• "CAMT.054.CN.DEMO5" to receive an example message for receipt of interest;
• "CAMT.054.CN.DEMO6" to receive an example message for cash deposit at branch;
• "CAMT.054.CN.DEMO7" to receive an example message for cash deposit at branch with service fee (the amount exceeds the free cash deposit limit);
• "CAMT.054.CN.DEMO8" to receive an example message for cash deposit at Coop store.

Dynamic Value Replacement

When Credit Notification is generated, certain dynamic values within the message are replaced. These dynamic elements include:

• <MsgId>: Located at <BkToCstmrDbtCdtNtfctn> → <GrpHdr> → <MsgId>. Created based on the date and time of message creation according to Tallinn time zone.
• <CreDtTm>: Located at <BkToCstmrDbtCdtNtfctn> → <GrpHdr> → <CreDtTm>. Created based on the date and time of message creation according to Tallinn time zone.
• <CreDtTm>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <CreDtTm>. Created based on the date and time of message creation according to Tallinn time zone.
• <Id>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Id>. Created based on the date and time of message creation according to Tallinn time zone.
• <IBAN>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Acct> → <Id> → <IBAN>. Replaced based on the debtor account from the incoming Payment Initiation XML.
• <Nm>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Acct> → <Ownr> → <Nm>. Replaced based on the debtor name from the incoming Payment Initiation XML.
• <Dt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <BookgDt> → <Dt>. Created based on the date of message creation according to Tallinn time zone.
• <Dt>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <ValDt> → <Dt>. Created based on the date of message creation according to Tallinn time zone.
• <Ustrd>: Located at <BkToCstmrDbtCdtNtfctn> → <Ntfctn> → <Ntry> → <NtryDtls> → <TxDtls> → <RmtInf> → <Ustrd>. The date inside the <Ustrd> element in the Cash deposit at Coop store message example is created based on the date of message creation according to Tallinn time zone.

Notes

• Credit Notification will be returned in addition to Debit Notification. However, the availability of the notifications depends on the specific services included in the Coop Pank Gateway contract.
• <Ustrd> element is not mandatory, but expected to receive Credit Notification.
• There should be only one <Ustrd> element in the Payment Initiation XML. In case there are multiple transactions in the Payment Initiation XML, the last transaction in the file must have the <Ustrd> element with specific value.
• Credit Notification will only be returned if the <Ustrd> value matches one of the previously defined values under Description section. For any other value Credit Notification will not be returned.
• The response message will vary based on the input provided in <Ustrd> element, so please ensure values align with the expected outcomes in your system.
• Credit Notification has certain dynamic values that are replaced in the message. Some of the values are replaced based on the incoming Payment Initiation XML.

Payment Initiation

Service for executing payments.

Payment Initiation Request

POST [base-url]/gateway/api/payment

Coop Pank uses the request message format: Customer to bank Payment Initiation (XML new type pain.001.001.09 and old type pain.001.001.03) and it covers SEPA, SEPA Instant, Internal and SWIFT Payments.
One payment initiation message may contain multiple single payments.

For the status of imported payments Coop Pank returns Payment Status Report (XML type pain.002.001.12). One payment may have one to many statuses.

Payment confirmation methods

Every payment should be confirmed by the customer, most of them by using Strong Customer Authentication (SCA). This requirement comes from the Payment Service Directive 2 (PSD2).

Gateway API currently supports the following two options and the client himself can choose which one to use.

Pending Payments

Format for payment files: XML. Payment files will be processed and debited from the account after confirmation, not instantly. Payments must be confirmed in the Internet bank or in mobile application under Pending payments section and can be signed and confirmed only there. Internet Bank daily and monthly limits apply. At first the signer's personal limit (A limit) is taken in account. If it's not enough, the shared limit (A+A limit) will be used.

header Content-Type: application/xml

Signed Payments in DigiDoc Container

Estonian standard for payment files are BDOC or ASIC-E container. Internet bank daily and monthly limits and signature rights apply. If more than one signature is necessary to sign the payment, all signatures must be included in the container. Limit usage is taken into account for every signer - the requested amount is subtracted from every signer's limit.

A legal entity can transfer payment files with the company's digital stamp (e-Seal). The bank only accepts qualified digital stamps issued by SK ID Solutions AS (SK) - FIPS and QSCD, in which the identity of the certificate user has been identified. The company is subject to daily and monthly limits for transferring payment files with a digital stamp within the Gateway product (limits are stated in Coop Pank Gateway contract). A legal entity that uses a company's digital stamp must have defined daily and monthly limits applicable to the company, against which payments transmitted with a digital stamp are checked. A legal entity can authorize another legal entity to make payments from its account using its own digital stamp - if interested in using this option, please inform your Business Client Manager.

header Content-Type: application/vnd.etsi.asic-e+zip

XML file should be named "request.xml". This file should be put into the BDOC or ASIC-E container and added required signature(s). Signed container has to be put into the body of the message. Internet Bank daily and monthly limits apply. At first the signer's personal limit (A limit) is taken in account. If it's not enough, the shared limit (A+A limit) will be used. The same process will apply for all the signatures added to the container.

Payment types and scheme selection

Gateway API currently supports following payment schemes:

• SEPA Instant (SCT Inst)
• Internal
• SEPA 
• SWIFT

Only automatic payment scheme selection decisions can be done.

• To other Coop Pank accounts - Bank internal payment
• If payment currency is EUR and the receiving bank is a member of the RT1 or TIPS clearing and settlement system for Instant payments - payment is sent as SEPA Instant. 
• If Instant payment cannot be processed for different reasons it is changed to SEPA.
• For other EUR payments in the European Economic Area (EEA) - SEPA payment.
• Other payments not in EUR or where beneficiary bank is not in the EEA - Swift payment.

Clearing times and limitations

More information could be found on Coop Pank's webpage under Payment section.

XML format (new pain.001.001.09 version)

Coop Pank is using custom version of pain.001.001.09.xsd

Request's Content-Type has to be 'multipart/form-data' and it has to contain XML file in "request" position, with its type also defined as "application/xml" or "application/vnd.etsi.asic-e+zip".

XML rules

Multiplicity (MULT.) informs how many times an element can or must be used, as defined by ISO standard.

• 1..1 Shows that element is mandatory and can be presented only once.
• 1..n Shows that element is mandatory and can be presented 1 to n times.
• 0..1 Shows that element is optional and can be presented only once.
• 0..n Shows that element is optional and can be presented 0 to n times. Note: True value of “n” represents unlimited number of occurrences.

Message structure

Group Header – mandatory, occurs once.
Payment Information – mandatory and repetitive. Contains information related to mostly the debit side of the payment.
Credit Transfer Transaction Information – mandatory and repetitive. Contains information related to the payment(s) included in the message.

Message root

Group header

Payment information

XML format(OLD pain.001.001.03 version)

XML format used by Coop Bank is a bit customized version of pain.001.001.03.xsd, still compliant with and has less restrictions than 1.4 version of the Estonian Banking Association implementation of pain.001.001.03. Coop Bank custom XSD is more restrictive that generic ISO 20022 XSD. Every XML file valid according to Coop Bank custom XSD is also valid to generic pain.001.001.03.

Generic pain.001.001.03 message xml schema file is available at www.iso20022.org.

Request's Content-Type has to be 'multipart/form-data' and it has to contain XML file in "request" position, with its type also defined as "application/xml" or "application/vnd.etsi.asic-e+zip".

XML rules

Multiplicity (MULT.) Informs how many times an element can or must be used, as defined by ISO standard.

• 1..1 One occurrence (required)
• 1..n One or several occurrences (value for “n” represents total number of occurrences)
• 1..3 Minimum one occurrence must be used and maximum 3 occurrences can be used. Note: True value of “n” represents unlimited number of occurrences.
• 0..1 None or one occurrence to be used (optional)
• 0..n None or several occurrences can be used (value for “n” represents total number of occurrences). Note: True value of “n” represents unlimited number of occurrences.

Message structure

Group Header – mandatory, occurs once.
Payment Information – mandatory and repetitive. Contains information related to mostly the debit side of the payment.
Credit Transfer Transaction Information – mandatory and repetitive. Contains information related to the payment(s) included in the message.

Elements

Payment information

Samples

Samples of payments and related messages for typical use cases depending on payment schemes and other details.

Response

XML format (ISO 20022 Customer Payment Status Report pain.002.001.12)

After payment request the customer will receive the response message - ISO 20022 Customer Payment Status Report (pain.002.001.12). This message is sent to the client to inform about the status of a payment instruction sent via Gateway API with Payment Initiation (pain.001.001.03) message.

Customer Payment Status Report refers to the original Payment Initiation message and gives feedback about the status of the process - provides positive, negative and pending status updates to original payments.
There can be many Customer Payment Status Reports per one Payment Initiation message - typically if any of the transactions was not accepted right away for any reason.

It is possible to order the Payment Status Report messages with the digital stamp of Coop Pank, see more details Digital stamp of Coop Pank.

Payment status codes and descriptions

Statuses are reported on group level for the whole payment instruction (GrpSts and PmtInfSts tags) and separately for each payment (TxSts tag).
Group level statuses are reported only in the first payment response message after the initial request.
Further responses (if any) shall not contain GrpSts and PmtInfSts tags - you must process the result of every payment entry separately.

Group level statuses (OrgnlGrpInfAndSts.GrpSts and OrgnlPmtInfAndSts.PmtInfSts):

• RJCT – all payments in the forwarded XML file have been rejected.
• PDNG - pending, payments are waiting for confirmation in Internet Bank.
• PART – payment has been accepted, settlement is in process. Processing the payment is in the bank, it hasn't been debited from client account or sent to clearing system.
• ACSP - all payments in the forwarded XML file are in statuses of "In progress" or "Debited", but not debited from the customer's account yet.

Single payment statuses (OrgnlPmtInfAndSts.TxInfAndSts.TxSts):

• PDNG - pending, payments are waiting for confirmation in Internet Bank.
• RJCT – rejected. One payment out of the group has been rejected (final status).
• ACSP – accepted, settlement in process. Payment is being processed by the bank, it has not been debited from client account nor sent to clearing system. At least one more status update must follow (either accept or reject).
• ACSC – accepted, settlement completed and payment has been debited from client account.

Pending payments need confirmation in Internet Bank

When payment receives PDNG status after ACSP status (payment is accepted by the customer) it means that the payment needs confirmation in Internet Bank.

Payment rejection due to account balance or limits

By default, all payments will be rejected right away when there is not enough free balance or payments limits to execute the payment.

Message structure

Group Header – mandatory, occurs once. Set of characteristics shared by all individual payments included in the status report message.
Original Group Information And Status – occurs once. Refers to original Payment Initiation Group Level information. Transaction Information And Status – optional and repetitive. Includes information about the original payment and its status.

Elements