Skip to content

Count the number of processed transactions

Request

The requests must:

Send a POST request to {YOUR DWH URL}/api/v2/transactions/count with the following parameters:
Parameter Type Description
options object
time_zone string The PSP timezone as defined here, for example, Europe/Vilnius.

Default value is Etc/UTC. Make sure to send this parameter if your timezone is different from UTC+00:00.
filter object
date_from * required
 string A start date of the reporting period in ISO 8601 format — YYYY-MM-DDThh:mm:ss±hh:mm or YYYY-MM-DDThh:mm:ss, for example, 2024-01-24T23:13:39+03:00.

The timezone in the parameter value must match the one specified in options.time_zone.

The date must occur within 90 days before the value of the date_to parameter.
date_to * required
 string An end date of the reporting period in ISO 8601 format — YYYY-MM-DDThh:mm:ss±hh:mm or YYYY-MM-DDThh:mm:ss, for example 2024-01-24T23:13:39+03:00.

The timezone in the parameter value must match the one specified in options.time_zone.

The date must occur within 90 days after the value of the date_from parameter.
date_type string A date type.

Possible values:
created_at is a date when a transaction is created (set by default);
paid_at is a date when a transaction is paid;
updated_at is a date when a transaction is updated.
merchant_id string Merchant IDs. Submit as a string with one or more values separated with commas.
shop_id string Shop IDs. Submit as a string with one or more values separated with commas.
uid string (36) Transaction identifier.
description string (1024) Transaction description.
type string Transaction types. Submit as a string with one or several values separated with commas.

Possible values:
authorization,
payment,
tokenization,
payout,
capture,
void,
refund,
credit,
chargeback.
status string Transaction statuses. Submit as a string of values separated with commas.

Possible values:
successful,
failed,
incomplete,
error,
pending.
amount string Transaction amount. Submit as a string with one or more big integer values, separated with commas.
currency string Transaction currency. Submit as a string with a single or multiple values separated with commas. The values must be in the ISO-4217 format, for example, USD.
test boolean By default, false. If true, the data on test transactions will be returned.
code string (7) Transaction result code.
recurring_type string Submit as a string with a single or multiple values separated with commas.

Possible recurring types:
recurring,
initial,
null.
fraud string Fraud check result.

Possible values:
reject - the transaction was rejected, for example, if the card's BIN is in the blacklist,
review - the transaction is under review of the PSP.
tracking_id string (500) A transaction identifier in the merchant's system.
gateway_id string Identifier(s) of payment gateway(s) enabled for the merchant's shop. Submit as a string with a single or multiple integer values separated with commas.
gateway_type string Name(s) of payment gateway(s) enabled for the merchant's shop. Submit as a string with a single or multiple values separated with commas.
gateway_agent_id string Identifier(s) of merchant's agent account(s). Submit as a string with a single or multiple integer values separated with commas.
shop_business_category_id integer Business category assigned to the merchant's shop.
provider_raw_rrn string (64) A retrieval reference number. A transaction ID issued by a card processing network.
provider_raw_ref_id string (510) Transaction identifier in the provider's system.
customer_id string Customer's ID in the PSP system.
customer_ip string (255) The customer's IP address upon making a payment.
customer_full_name string (255) The customer's full name (first name, last name and patronymic).
customer_phone string (100) The customer's phone number.
customer_email string (255) The customer's email address.
method_type string A payment method.

Possible values:
credit_card stands for card payment methods;
alternative stands for non-card payment methods.
method_alternative_account string (255) Payment method attribute, for example, an account in the alternative payment method system.
credit_card_product string (255) A card brand or product
credit_card_first_1 string (1) The first 1 digit of a credit card
credit_card_bin string (6) 6-digit bank identification number.
credit_card_bin_8 string (8) 8-digit bank identification number.
credit_card_last_4 string (8) The last 4 digits of the card number.
credit_card_holder string (70) A cardholder's name.
credit_card_brand string (60) A card brand.
credit_card_sub_brand string (60) A card sub-brand
credit_card_stamp string (128) A card hash. It is constant even if the expiration date or card holder are changed.
credit_card_issuer_country string (2) A country of the bank that issued the card in the ISO 3166-1 alpha-2 format.
recipient_customer_id string Recipient's ID in the PSP system.
recipient_customer_ip string (255) The recipient's IP address upon making a payment.
recipient_customer_full_name string (255) The recipient's full name (first name, last name and patronymic).
recipient_customer_email string (255) The recipient's email address.
recipient_customer_phone string (100) The recipient's phone number.
recipient_credit_card_product string (255) A brand or product of the recipient's card.
recipient_credit_card_first_1 string (1) The first 1 digit of the recipient's card.
recipient_credit_card_bin string (6) 6-digit bank identification number of the recipient's card.
recipient_credit_card_bin_8 string (8) 8-digit bank identification number of the recipient's card.
recipient_credit_card_last_4 string (8) The last 4 digits of the recipient's card number.
recipient_credit_card_holder string (70) A holder's name of the recipient's card.
recipient_credit_card_brand string (60) A brand of the recipient's card.
recipient_credit_card_sub_brand string (60) A sub-brand of the recipient's card.
recipient_credit_card_stamp string (128) The hash of the recipient's card. It is constant even if the expiration date or card holder are changed.
recipient_credit_card_issuer_country string (2) The country of the bank that issued the recipient's card in the ISO 3166-1 alpha-2 format.
Request example 
{
  "filter": {
    "date_from": "2024-01-01T23:19:39+02:00",
    "date_to": "2024-01-02T23:19:39+02:00"
  },
  "options": {
    "time_zone": "Europe/Vilnius"
  }
}

Response

The response contains the following parameters:
Parameter Type Description
data object A section of transaction details.
count integer A number of transactions that meet the request parameters.
Response example 
{
    "data": {
        "count": 1251
    }
}