zimpler-developers

Reporting

# Listing transactions

# GET /v4/transactions

Transactions can be listed as a JSON array ordered with the newest first.

A maximum of 1000 objects are returned in a single request. Use limit and offset to paginate and retrieve more items. To retrieve only items from a certain time period use from_date and to_date. The from_date and to_date should both be before or after 2021-01-01. You can also filter per country_code and site.

An opptional time can also be supplied to from_date and to_date in the format of 2021-01-01T23:59:00Z.

# REQUEST

/v4/transactions?limit=100&offset=200&ascending=true&country_code=SE&from_date=2017-03-23T23:59:00Z
PARAM TYPE Default Description
limit Integer (max: 1000) 100 The number of transactions to return
offset Integer 0 Used for pagination
ascending Boolean true Whether the transaction are sorted by approved_at in ascending or descending order
country_code CountryCode null If provided, will return transactions only for this country code
site String null If provided, will return transactions only for this site
from_date Date 2021-01-01 If provided, will return transactions approved on or after given date (UTC)
to_date Date today If provided, will return transactions approved on or before given date (UTC)

# RESPONSE

{
  "count": 3,
  "transactions": [
    {
      "id":"6a734480-a051-4a05-8405-ac2d8f49102f",
      "type":"deposit",
      "product": "zimpler_bank",
      "approved_at":"2017-03-23T07:06:11Z",
      "amount":"100.00",
      "country_code":"SE",
      "fee_amount":"-6.50",
      "currency":"EUR",
      "ref": "merchant-transaction-ref",
      "site": "example.com",
      "account_ref": "example-merchant-ref"
    }, {
      "id":"6a734480-a051-4a05-8405-ac2d8f49102f",
      "type":"withdrawal",
      "product": "withdrawal",
      "approved_at":"2017-03-23T07:06:11Z",
      "amount":"-100.00",
      "country_code":"SE",
      "fee_amount":"-6.50",
      "currency":"EUR",
      "ref": "merchant-transaction-ref",
      "site": "example.com",
      "account_ref": "example-merchant-ref",
      "payment_ref": "ZRrbcjf84R",
    }, {
      "id":"6a734480-a051-4a05-8405-ac2d8f49102f",
      "type":"recurring-charge",
      "product": "zimpler_bank",
      "approved_at":"2017-03-23T07:06:11Z",
      "amount":"100.00",
      "country_code":"SE",
      "fee_amount":"-6.50",
      "currency":"EUR",
      "ref": "merchant-transaction-ref",
      "site": "example.com",
      "account_ref": "example-merchant-ref"
    },
  ]
}

# Current Balance

# GET /v4/current_balance

# REQUEST

/v4/current_balance

# Response

{
    "SEK": {
        "total": "25000.00",
        "pending": "1000.00",
        "available": "24000.00",
    },
    "EUR": {
        "total": "2500.00",
        "pending": "100.00",
        "available": "2400.00",
    },
}