How to get bank transactions via the API?

We recently added the concept of bank transactions. All transaction information can be found in the Space under Settlement > Bank Transactions.

Types of transactions

There are different type of Transactions. The following are necessary for the reconciliation:

• Charge - A Charge Bank Transaction is a settlement of an acquirer for a transaction. A charge normally consists of a gross settlement amount minus the settlement fees of the acquirer. If possible we also provide a value date when this amount is settled to an account. 
• Refund - A refund is the payout transaction to the customer for refunds. This provides the information when the refund has been deducted from your balance and is settled to the customer. 
• Internal Transfer - is the internal transfer from the acquirer to your bank account - normally those are the settlements to your bank account. 

Process

The best way is that for each order in your web shop you create a corresponding order in your ERP. With the bank transfer API you can now close those records as you get the information when, where the payment happened and what the fees were. 

So there is all necessary information to close the record in your ERP. 

How to search for bank transactions via the API

For each of the types there is an API Endpoint. So what you need to implement is to search for the transactions using the search endpoint for the different types of transactions. Below is a sample query that shows how to do a range query for a time period showing you 100 entries starting at the date (below the 21st of January 2021. you can then navigate through the list by adjusting the starting entry.

Example:

{
    "filter": {
        "fieldName": "bankTransaction.createdOn",
        "operator": "GREATER_THAN_OR_EQUAL",
        "type": "LEAF",
        "value": "2021-01-21T00:00:00"
    },

    "startingEntity": 0,

    "numberOfEntities": 100,
    "orderBys": [
        {
            "fieldName": "id",
            "sorting": "ASC"
        }
    ]
}