Account statements

You can get bank statements for your settlement or escrow account opened in rubles. Statements can only be generated for a day.

To get a statement, use the account_statement method.

Request parameters

Name	Mandatory	Type	Description
X-PARTNER-PROJECT	+	string	Project identifier. Get it from your Bank 131 manager
X-PARTNER-SIGN	+	string	Request signature
date_from	+	date	Statement start date. Example: 2023-06-01
date_to	+	date	Statement end date. Example: 2023-06-01
account_number	+	string	Account number (20 digits) for which you request a statement

The date_from and date_to values must match.

Request example

https://demo.bank131.ru/api/v1/report/account_statement \
  -H 'Content-Type: application/json' \
  -H 'X-PARTNER-PROJECT: your_project_name' \
  -H 'X-PARTNER-SIGN: 721af394d5a7aefd0e91f5390abc4d7e20fb2b5784b091fef621f3c61b7abb4b' \
  -d '{
    "date_from": "2023-06-01",
    "date_to": "2023-06-01",
    "account_number": "40702810600200000014"
}

Response parameters

Name	Mandatory	Type	Description
status	+	string	{"ok","error"}
name	+	string	Method name (`account_statement`)
account_statement	+	AccountStatement	Statement details
date_from	+	date	Statement start date
date_to	+	date	Statement end date
account_number	+	string	Account number (20 digits) for which the statement is generated
total_turnover	+	TotalTurnover	Information on funds movement
debet	+	int	Total debits over the period covered by the statement
credit	+	int	Total credits over the period covered by the statement
total_balance	+	TotalBalance	Balance information
opening	+	int	Opening balance on the statement start date
closing	+	int	Closing balance on the statement end date
transactions	+	Transactions	Information on transactions
amount	+	int	Transaction amount (debits are shown as negative values, credits as positive ones)
base_amount	+	int	Transaction amount in the base currency
currency	+	string	Transaction currency
payment_date	+	date	Transaction date
bank_system_id	+	string	Payment identifier. It is specified for all kinds of payments: - for payments sent via the API - for transfers from another bank - for payments made through online banking
transaction_id	-	string	Transaction identifier. It is specified for payments sent via the API
session_id	-	string	Session identifier. It is specified for payments sent via the API
purpose	+	string	Payment purpose
counter_party	+	CounterParty	Counterparty details
kpp	-	string	Counterparty's KPP
inn	-	string	Counterparty's INN
name	+	string	Counterparty's name
account_number	+	string	Counterparty's account number
bank_code	+	string	Counterparty's bank BIK

Successful response example

{
    "status": "ok",
    "account_statement": {
        "date_from": "2023-06-01",
        "date_to": "2023-06-01",
        "account_number": "40702810900000000011",
        "total_turnover": {
            "debet": 14616,
            "credit": 0
        },
        "total_balance": {
            "opening": 499138708,
            "closing": 499124092
        },
        "transactions": [
            {
                "amount": -808,
                "base_amount": 808,
                "currency": "RUB",
                "payment_date": "2023-06-01",
                "bank_system_id": "2080040124597537",
                "transaction_id": "pm_771797",
                "session_id": "ps_1062395",
                "purpose": "Payout  to card 430000******0777",
                "counter_party": {
                    "kpp": "165501001",
                    "inn": "1655415696",
                    "name": "Bank 131",
                    "account_number": "30233810100000000002",
                    "bank_code": "049205131"
                }
            },
            {
                "amount": -808,
                "base_amount": 808,
                "currency": "RUB",
                "payment_date": "2023-06-01",
                "bank_system_id": "2080040124597553",
                "transaction_id": "pm_771799",
                "session_id": "ps_1062397",
                "purpose": "Payout to card 430000******0777",
                "counter_party": {
                    "kpp": "165501001",
                    "inn": "1655415696",
                    "name": "Bank 131",
                    "account_number": "30233810100000000002",
                    "bank_code": "049205131"
                }
            },
            {
                "amount": -6500,
                "base_amount": 6500,
                "currency": "RUB",
                "payment_date": "2023-06-01",
                "bank_system_id": "2080040124597554",
                "transaction_id": "pm_771799",
                "session_id": "ps_1062397",
                "purpose": "Bank`s fee for transferring funds under agreement No.2pr Rko test of 20.01.2020 , VAT exempt",
                "counter_party": {
                    "kpp": "165501001",
                    "inn": "1655415696",
                    "name": "Bank 131",
                    "account_number": "70601810000002740201",
                    "bank_code": "049205131"
                }
            },
            {
                "amount": -6500,
                "base_amount": 6500,
                "currency": "RUB",
                "payment_date": "2023-06-01",
                "bank_system_id": "2080040124597538",
                "transaction_id": "pm_771797",
                "session_id": "ps_1062395",
                "purpose": "Bank`s fee for transferring funds under agreement No.2pr Rko test of 20.01.2020 , VAT exempt",
                "counter_party": {
                    "kpp": "165501001",
                    "inn": "1655415696",
                    "name": "Bank 131",
                    "account_number": "70601810000002740201",
                    "bank_code": "049205131"
                }
            }
        ]
    }
}

Unsuccessful response examples

`date_from` does not match `date_to`

{
    "status": "error",
    "error": {
        "description": "Invalid input request parameters:  (max interval is 1 day)",
        "code": "invalid_request"
    }
}

`date_from` is greater than `date_to`

{
    "status": "error",
    "error": {
        "description": "Invalid input request parameters:  (date_to must be greater than date_from);  (max interval is 1 day)",
        "code": "invalid_request"
    }
}

Invalid date in `date_from` or in `date_to`

{
    "status": "error",
    "error": {
        "description": "Invalid value in date_from",
        "code": "invalid_request"
    }
}

{
    "status": "error",
    "error": {
        "description": "Invalid value in date_to",
        "code": "invalid_request"
    }
}

Invalid JSON format

{
    "status": "error",
    "error": {
        "description": "Invalid request",
        "code": "invalid_request"
    }
}

Internal error

This response is returned in the following cases:

the account number is specified incorrectly
the specified account does not exist
the specified account does not belong to the user who initiated the request

{
  "status": "error",
  "error": {
      "description": "Internal error",
      "code": "internal_error"
    }
}

Request parameters​

Request example​

Response parameters​

Successful response example​

Unsuccessful response examples​

date_from does not match date_to​

date_from is greater than date_to​

Invalid date in date_from or in date_to​

Invalid JSON format​

Internal error​