Enrich bank transfer data

Before you begin with this guide, you should have the basic knowledge from Getting started with Tapix tutorial.

In this guide you will learn how to integrate Tapix APIs to enrich your users data coming from bank transfers.

Keep in mind that different countries use different standards for bank transfers thus we provide different endpoints to enrich them. Tapix supports SEPA (standard used in many European countries - learn more here), BACS / Faster Payment bank transfer (standards used in the UK), CERTIS (standard used in Czech Republic) and JoPACC (standard used in Jordan). Tapix also offers a dedicated endpoint for person-to-person bank transfer enrichment.

Before you start with implementation, keep in mind the following:

  • For all bank transfer data endpoints we recommend that you cache all request parameters for 24 hours except for refresh and aggCount parameters
  • Always cache complete API response
  • You can choose whether you want to call Tapix for every bank transfer or cache the result and read the response from the cache. For the latter case you should also store the number of times this record was hit from the cache. After you discard the cache and call Tapix again for the same record, also send us the aggCount parameter with the value of how many times it was hit. Then reset the aggCount to 0 and repeat for every other call.
  • If you want to keep your historical data correct, check endpoint invalidations and discard its results from the cache
  • Cache statistics delivery is a system that helps to improve data quality for you. Meaning you can cache results so you do not have to call Tapix API every time, but in order to improve data quality, Tapix needs to know how many times you have read the cached result and used it. Whenever you delete the record from cache, just add parameter aggCount whenever you send a request for the same record to keep Tapix informed.

Please note that whenever the record is invalidated through invalidations, you should take the appropriate action given the level and type. After that you should call the respective endpoint for the transactions previously mapped to the invalidated records, with a parameter refresh = true.

You can also use sandbox with samples from this guide or try the API on your own.

Note that in case any parameter has an empty value (null or empty string), still send it as a parameter with an empty value. Contrary, if you do not have access to a parameter omit this parameter completely in your requests. Always check with Dateio about missing parameters in order to make sure the quality of the service is not harmed and continuously improves. If any parameters are missing please contact support@tapix.io.

Get information from raw data from SEPA bank transfer

For every transfer that happens within the SEPA system using Euros (EUR), you will use endpoint /shops/findByBankTransfer/sepa.

For this endpoint you have many parameters you can use. Head to documentation of /shops/findByBankTransfer/sepa to get the full grasp of what parameters you can use.

If you just want to try the API out, find the cURL option next to the API request in the documentation. Keep in mind you have to be registered for the testing.

Ideal scenario

In an ideal world you should provide as much information as possible. The query, in such case, should look something like this:

/v6/shops/findByBankTransfer/sepa?bic=ING%20BNL2A&iban=NL89INGB0000231412&city=Amsterdam&zip=1012%20XG&country=NL&refresh=false

For which the response will be this:

{
    "result": "found",
    "handle": "qepY7ojyZbZijjlY1aAr1X",
    "shop": {
        "uid": "qepY7ojyZbZijjlY1aAr1X"
    }
}

As you can see, you successfully retrieved information necessary to proceed with getting information about the store. Head to Get shop and merchant information tutorial where you learn how to receive information about shops and merchants.

You can also use sandbox with samples from this guide or try the API on your own.

Not so ideal scenario

Sometimes you may find yourself in a situation where you don't have all the information needed or Tapix does not know to which shop the transfer belongs.

Not enough information provided or Tapix doesn't know the shop

When you do not possess all the necessary information we may not be able to provide you with additional information.

In this example below we receive an unsolved handle. The query used might look like this:

/v6/shops/findByBankTransfer/sepa?bic=ING%20BNL2A&city=Amsterdam&zip=1012 XG&refresh=false

For which the response will be this:

{
    "result": "unsolved",
    "handle": "!Vk8sklVc0XR8kEtPERqMRK"
}

Notice that in this situation we still return HTTP status 200.

Unfortunately, in such cases we cannot provide any information about the shop because the data provided in the request are not sufficient. In such cases, always contact Dateio to find out whether the input data are not sufficient for the enrichment, or the input data are correct but the problem is in the current data coverage in your region. Reach us at support@tapix.io.

You can also use sandbox with samples from this guide or try the API on your own.

Get information from raw data from BACS / Faster Payment bank transfer

For bank transfers used within the United Kingdom, in British Pounds (GBP), you shall head to endpoint /shops/findByBankTransfer/uk. For this endpoint you have many parameters you can use. Head to documentation to get the full grasp of what parameters you can use or head to sandbox.

Ideal scenario

Please note, you should always provide as much information as possible to ensure the highest quality of data enrichment possible. If you have access to all the necessary parameters, just like in this query:

/v6/shops/findByBankTransfer/uk?accountNumber=23908394&paymentType=O&paymentMethod=FP&name=FEDEX%20EXPRESS%20UK%20TRA&sortCode=013099&refresh=false

Your responses could look like this:

{
    "result": "found",
    "handle": "kLr8DbqrLpfnzrzLZWPe9",
    "shop": {
        "uid": "kLr8DbqrLpfnzrzLZWPe9"
    }
}

As you can see, you successfully retrieved information necessary to proceed with getting information about the store. Head to Get shop and merchant information tutorial where you learn how to receive information about shops and merchants.

You can also use sandbox with samples from this guide or try the API on your own.

Not so ideal scenario

Sometimes you don't have access to all the parameters or some are missing. In such cases the result returned might be insufficient to provide you with more data. Also you may provide all relevant data but Tapix just does not recognize such payment. In such cases, you are confronted with an unsolved handle, meaning that Tapix doesn't have access to more data.

Example query in this case could be this one:

/v6/shops/findByBankTransfer/uk?paymentType=I&paymentMethod=FP&sortCode=242646&accountNumber=33445566&name=JOHN%20DOE&country=GB&refresh=false

Response returned would be as following:

{
    "result": "unsolved",
    "handle": "!VlZtp98VtvXmX87Cf7IAnF"
}

As said before, in this case the information provided wasn't sufficient to find a respective shop. In such cases, always contact Dateio to find out whether the input data are not sufficient for the enrichment or the input data are correct but the problem is in the current data coverage in your region. Reach us at support@tapix.io.

You can also use sandbox with samples from this guide or try the API on your own.

Get information from raw data from CERTIS bank transfer

Standard used within the Czech Republic is called CERTIS and works solely for bank transfers using Czech Crowns (CZK) in the environment of Czech banks. If you wish to implement data enriching for transfers using CERTIS, you will need to integrate endpoint /shops/findByBankTransfer/certis - in the documentation you find the list of all possible parameters. Or head to the sandbox to try it out yourself.

Ideal scenario

In case you have all the information regarding the party you are trying to identify, such as in the following query:

/v6/shops/findByBankTransfer/certis?accountNumberPrefix=&accountNumber=188505042&bankCode=0300&accountName=Alza.cz%20a.s.&paymentType=O&message=Invoice%20Payment&note=laptop%20alza&refresh=false

You will be rewarded with a success response populated with the additional information you can use, such as the following:

{
    "result": "found",
    "handle": "Xev87bVd9EXtMWvAaWm8Qe"
    "shop": {
        "uid": "Xev87bVd9EXtMWvAaWm8Qe"        
    }
}

As you can see, you successfully retrieved information necessary to proceed with getting information about the store. Head to Get shop and merchant information tutorial where you learn how to receive information about shops and merchants.

You can also use sandbox with samples from this guide or try the API on your own.

Not so ideal scenario

At certain times, when you don't have access to all the parameters or some are missing, the result returned might be insufficient to provide you with more data. In such cases, you are confronted with an unsolved handle, meaning that either the input data are not sufficient or the account remains unknown and Tapix cannot currently provide more data.

Example query in this case could be like this:

/v6/shops/findByBankTransfer/certis?bankCode=3030&refresh=false

Response returned would be as following:

{
    "result": "unsolved",
    "handle": "!7GfEUnA8uF1aull3O89Dly"
}

Unfortunately, in this case the information provided wasn't sufficient to find a respective shop. In such cases, always contact Dateio to find out whether the input data are not sufficient for the enrichment or the input data are correct but the problem is in the current data coverage in your region. Reach us at support@tapix.io.

You can also use sandbox with samples from this guide or try the API on your own.

Where to head next

The next step is getting information about shops and merchants which you learn about in Get shop and merchant information tutorial. You can learn more about integrating invalidations which serve to keep your data up-to-date. You can also integrate and enrich Open Data payments or enrich card transactions for additional data.