Payment transactions

This object represents payment transactions for both successful (executed) and unsuccessful (declined) payments. It is based on JSON and suitable for data lake and analytics applications.

Note: Access to this API is plan specific. Please contact your Customer Success Manager for more information.

This is part of the Data Export API licensing package.

Filters can be applied to make your query more specific by including executionDate and initiator.businessId.

📘
Separators are included as coma symbols and filters with ampersand symbols

Filters

You find below a few examples of possible filter values that you can submit in the request to narrow down your search.

initiator.bankAccount.accountCurrency=CHF
executionDate>2023-01-01
process.incomingTime>2023-04-27
transactionType=DEBIT
paymentMethod=DOMESTIC
initiator.businessId=145236
initiator.bankAccount.accountBusinessId=BABB8E757H
initiator.bankAccount.bankCountry=DEU
process.status=TMOK

Include parmaters

You may use any of the parameters below to make your query based on specific attribute:

transactionDetails
initiator
initiator.bankAccount
metadata
process
references
counterparty
counterparty.bankAccount
charges
cheque
cbr
directDebitDetails

Example request

curl --request GET \
     --url 'https://api-mtls.eu-test.tispayments.com:443/btm/payment/export/payment-transactions?include=initiator,initiator.bankAccount&filter=initiator.bankAccount.accountCurrency=CHF' \
     --header 'accept: application/json'

{
  "result": [
    {
      "executionDate": "2019-08-24",
      "valueDateInitiator": "2019-08-24",
      "valueDateCounterparty": "2019-08-24",
      "amount": "string",
      "currency": "string",
      "amountAccountCurrency": "string",
      "amountReferenceCurrency": "string",
      "transactionType": "string",
      "paymentMethod": "string",
      "paymentCategory": "string",
      "isUrgent": true,
      "liquidityCategory": "string",
      "directDebit": {
        "sepa": {
          "mandateId": "string",
          "mandateSignatureDate": "2019-08-24",
          "creditorId": "string",
          "debitType": "string",
          "sequenceType": "string"
        }
      },
      "metadata": {
        "id": "string",
        "editor": "string",
        "changeTime": "2019-08-24T14:15:22Z",
        "isModified": true,
        "paymentHeaderId": "string"
      },
      "process": {
        "status": "string",
        "incomingTime": "2019-08-24T14:15:22Z",
        "releaseTime": "2019-08-24T14:15:22Z",
        "transmissionTime": "2019-08-24T14:15:22Z",
        "incomingChannel": "string",
        "outgoingFileName": "string"
      },
      "references": {
        "endToEndReference": "string",
        "instructionReference": "string",
        "batchReference": "string",
        "incomingFileReference": "string",
        "outgoingFileReference": "string"
      },
      "initiator": {
        "businessId": "string",
        "name": "string",
        "country": "string",
        "bankAccount": {
          "accountBusinessId": "string",
          "bankBusinessId": "string",
          "bankName": "string",
          "bankBIC": "string",
          "bankCode": "string",
          "bankCountry": "string",
          "accountNumber": "string",
          "originalAccountNumber": "string",
          "accountSubNumber": "string",
          "accountIBAN": "string",
          "accountCurrency": "string"
        }
      },
      "remittanceInfo": {
        "text": "string"
      },
      "counterparty": {
        "name": "string",
        "businessId": "string",
        "country": "string",
        "address": "string",
        "city": "string",
        "state": "string",
        "organizationId": "string",
        "organizationIdScheme": "string",
        "privateId": "string",
        "privateIdScheme": "string",
        "email": "string",
        "phone": "string",
        "fax": "string",
        "bankAccount": {
          "bankName": "string",
          "bankBIC": "string",
          "bankCode": "string",
          "bankCountry": "string",
          "bankCity": "string",
          "bankZipCode": "string",
          "bankAddress": "string",
          "bankControlKey": "string",
          "branchCode": "string",
          "branchName": "string",
          "accountNumber": "string",
          "accountIBAN": "string",
          "accountType": "string"
        }
      },
      "charges": {
        "instructionCode": "string",
        "bankBIC": "string",
        "bankCode": "string",
        "accountIBAN": "string",
        "accountNumber": "string",
        "accountCurrency": "string"
      },
      "cheque": {
        "chequeNumber": "string",
        "memoText": "string",
        "chequeType": "string",
        "deliveryType": "string",
        "maturityDate": "2019-08-24",
        "formsCode": "string"
      },
      "cbr": {
        "transactionCode": "string",
        "counterpartyCountry": "string",
        "authorityCountry": "string",
        "authorityName": "string",
        "detailsText": "string",
        "detailsDate": "2019-08-24",
        "detailsType": "string"
      }
    }
  ]
}

📘Separators are included as coma symbols and filters with ampersand symbols

Filters

Include parmaters

Example request

📘
Separators are included as coma symbols and filters with ampersand symbols