Bank statements
This section guides you through the process of how to retrieve intraday and end of day statements in order to reconcile your payments and manage your cash and liquidity.
Customers can retrieve statements in the following formats:
| Intraday | End of day |
|---|---|
| CAMT_052_001_02 CAMT_052_001_03 | CAMT_053_001_02 CAMT_053_001_04 |
| MT942_FILE | MT940_FILE |
| BAI2_FILE | |
| CSB43 |
1. Collections: retrieve a list of bank statements
To retrieve a list of available statements, you must include the client-system-id associated with your API client, channeleither _btm.mappingEngine for in-mapped statements or message channel ID for pass through statements, and optionallyfile-format for example CAMT_053_001_02.
curl --request GET \
--url 'https://api-mtls.eu-test.tispayments.com:443/rest/api/btm/files?client-system-id=<client_system_name>&channel=_btm.mappingEngine&file-format=<file_format>' \
--header 'accept: application/json'
--header 'TIS-API-MODE: BTM'
{
"pageNumber": 1,
"numberOfPages": 2,
"pageSize": 50,
"totalNumberOfElements": 240,
"content": {
"fileMetaData": {
"fileId": "112233",
"filename": "my-statement.txt",
"fileFormat": "MT940_FILE",
"checksum": "{sha-1}b170b8f6c5d93a1ddb5d32c2df8709bce621e040",
"tenantId": "1234",
"createdOn": "2018-10-18T06:37:35.036"
},
"statementDetails": {
"listNumber": 10,
"bookingDate": "2018-10-15",
"bankAccount": {
"bankAccountNumber": "532013000",
"iban": "DE89370400440532013000",
"bank": {
"businessId": "BANK_DB_FFM",
"bic": "DEUTDEFFXXX",
"bankCode": "12345678",
"bankCountry": "DE"
},
"legalEntity": {
"businessId": "LE_GERMANY"
}
}
},
"links": {
"type": "array",
"items": {
"rel": "FileDownload",
"href": "https://api-mtls.eu.tispayments.com/rest/api/btm/files/108851654546147?client-system-id=curl"
}
}
},
"links": {
"rel": "FileDownload",
"href": "https://api-mtls.eu.tispayments.com/rest/api/btm/files/108851654546147?client-system-id=curl"
}
}
2. Items: retrieve a single bank statement
Use the hateoas link href" returned in step 1 to retrieve a singleton bank statement by including the fileIdand client-system-id as query strings. The response will return the statement data in the body as a byte stream in a supported data format, e.g. CAMT 053.
curl --request GET \
--url 'https://api-mtls.eu-test.tispayments.com:443/rest/api/btm/files/<file_ID>?client-system-id=<client_system_name>' \
--header 'accept: application/octet-stream'
--header 'TIS-API-MODE: BTM'
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Document
xmlns="urn:iso:std:iso:20022:tech:xsd:camt.053.001.02">
<BkToCstmrStmt>
<GrpHdr>
<MsgId>AAAASESS-FP-STAT001</MsgId>
<CreDtTm>2020-01-31T17:00:00+01:00</CreDtTm>
<MsgPgntn>
<PgNb>1</PgNb>
<LastPgInd>true</LastPgInd>
</MsgPgntn>
</GrpHdr>
<Stmt>
<Id>AAAASESS-FP-STAT001</Id>
<ElctrncSeqNb>577</ElctrncSeqNb>
<CreDtTm>2020-01-31T17:00:00+01:00</CreDtTm>
<FrToDt>
<FrDtTm>2020-01-31T08:00:00+01:00</FrDtTm>
<ToDtTm>2020-01-31T17:00:00+01:00</ToDtTm>
</FrToDt>
<Acct>
<Id>
<IBAN>DE89370400440532013000</IBAN>
</Id>
<Ownr>
<Nm>Deutsche Bank Frankfurt</Nm>
</Ownr>
<Svcr>
<FinInstnId>
<Nm>AAAA BANKEN</Nm>
<PstlAdr>
<Ctry>SE</Ctry>
</PstlAdr>
</FinInstnId>
</Svcr>
</Acct>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>OPBD</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="EUR">500000</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2010-10-15</Dt>
</Dt>
</Bal>
<Bal>
<Tp>
<CdOrPrtry>
<Cd>CLBD</Cd>
</CdOrPrtry>
</Tp>
<Amt Ccy="EUR">435678.50</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Dt>
<Dt>2020-01-31</Dt>
</Dt>
</Bal>
<Ntry>
<Amt Ccy="EUR">105678.50</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Sts>BOOK</Sts>
<BookgDt>
<DtTm>2020-01-31T13:15:00+01:00</DtTm>
</BookgDt>
<ValDt>
<Dt>2020-01-31</Dt>
</ValDt>
<AcctSvcrRef>AAAASESS-FP-CN_98765/01</AcctSvcrRef>
<BkTxCd>
<Domn>
<Cd>PAYM</Cd>
<Fmly>
<Cd>0001</Cd>
<SubFmlyCd>0005</SubFmlyCd>
</Fmly>
</Domn>
</BkTxCd>
<NtryDtls>
<TxDtls>
<Refs>
<EndToEndId>MUELL/FINP/RA12345</EndToEndId>
</Refs>
<RltdPties>
<Dbtr>
<Nm>MUELLER</Nm>
</Dbtr>
</RltdPties>
</TxDtls>
</NtryDtls>
<AddtlNtryInf>/LTC/8101-AV/GARAN 0018962300488020885/HTC/MSC</AddtlNtryInf>
</Ntry>
<Ntry>
<Amt Ccy="EUR">200000</Amt>
<CdtDbtInd>DBIT</CdtDbtInd>
<Sts>BOOK</Sts>
<BookgDt>
<DtTm>2020-01-31T10:15:00+01:00</DtTm>
</BookgDt>
<ValDt>
<Dt>2020-01-31</Dt>
</ValDt>
<AcctSvcrRef>AAAASESS-FP-ACCR-01</AcctSvcrRef>
<BkTxCd>
<Domn>
<Cd>PAYM</Cd>
<Fmly>
<Cd>0001</Cd>
<SubFmlyCd>0003</SubFmlyCd>
</Fmly>
</Domn>
</BkTxCd>
<NtryDtls>
<Btch>
<MsgId>FINP-0055</MsgId>
<PmtInfId>FINP-0055/001</PmtInfId>
<NbOfTxs>20</NbOfTxs>
</Btch>
</NtryDtls>
<AddtlNtryInf>/LTC/8101-AV/GARAN 0018962300488020885/HTC/MSC</AddtlNtryInf>
</Ntry>
<Ntry>
<Amt Ccy="EUR">30000</Amt>
<CdtDbtInd>CRDT</CdtDbtInd>
<Sts>BOOK</Sts>
<BookgDt>
<DtTm>2020-01-31T15:15:00+01:00</DtTm>
</BookgDt>
<ValDt>
<Dt>2020-01-31</Dt>
</ValDt>
<AcctSvcrRef>AAAASESS-FP-CONF-FX</AcctSvcrRef>
<BkTxCd>
<Domn>
<Cd>TREA</Cd>
<Fmly>
<Cd>0002</Cd>
<SubFmlyCd>0000</SubFmlyCd>
</Fmly>
</Domn>
</BkTxCd>
<NtryDtls>
<TxDtls>
<Refs>
<InstrId>FP-004567-FX</InstrId>
<EndToEndId>AAAASS1085FINPSS</EndToEndId>
</Refs>
<AmtDtls>
<CntrValAmt>
<Amt Ccy="EUR">3255</Amt>
<CcyXchg>
<SrcCcy>EUR</SrcCcy>
<XchgRate>0.1085</XchgRate>
</CcyXchg>
</CntrValAmt>
</AmtDtls>
</TxDtls>
</NtryDtls>
<AddtlNtryInf>/LTC/8101-AV/GARAN 0018962300488020885/HTC/MSC</AddtlNtryInf>
</Ntry>
</Stmt>
</BkToCstmrStmt>
</Document>
3. Confirm: a bank statement is retrieved
Confirm that a bank statement is retrieved by your server. This will ensure a statement that is already retrieved, it is no longer returned when calling the API.
curl --request PUT \
--url 'https://api-mtls.eu-test.tispayments.com:443/rest/api/btm/files/<file_ID>/confirmation?client-system-id=<client_system_name>' \
--header 'TIS-API-MODE: BTM'
204
Updated about 1 year ago