Bank API v1.0.0
Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.
Bank API.
Base URLs:
Authentication
Scope
Scope Description
read:accounts
Grant read accounts access.
read:transactions
Grant read transactions access.
create:transactions
Grant create transactions access.
- Flow: implicit
- Authorization URL = [https://api.bank.by/auth/login](https://api.bank.by/auth/login)
Scope
Scope Description
read:accounts
Grant read accounts access.
read:transactions
Grant read transactions access.
create:transactions
Grant create transactions access.
Public
GET /currencies
Code samples
curl -X GET https://api.bank.by/currencies \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Version: 1.0.0' \
-H 'Accept: applicaiton/json'
GET https://api.bank.by/currencies HTTP/1.1
Host : api.bank.by
Accept : applicaiton/json
Accept : application/json
Content-Type : application/json
X-Api-Version : 1.0.0
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'applicaiton/json'
};
$.ajax({
url : 'https://api.bank.by/currencies' ,
method : 'get' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'applicaiton/json'
};
fetch('https://api.bank.by/currencies' ,
{
method : 'GET' ,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'X-Api-Version' => '1.0.0' ,
'Accept' => 'applicaiton/json'
}
result = RestClient.get 'https://api.bank.by/currencies' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'X-Api-Version' : '1.0.0' ,
'Accept' : 'applicaiton/json'
}
r = requests.get('https://api.bank.by/currencies' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/currencies" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Currencies
Currencies.
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
X-Api-Version
header
string
false
API version (default latest).
lang
query
string(iso-639-1)
false
Language of text data (default belarusan).
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
This operation does not require authentication
GET /atms
Code samples
curl -X GET https://api.bank.by/atms \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Version: 1.0.0' \
-H 'Accept: application/json'
GET https://api.bank.by/atms HTTP/1.1
Host : api.bank.by
Accept : application/json
Accept : application/json
Content-Type : application/json
X-Api-Version : 1.0.0
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
$.ajax({
url : 'https://api.bank.by/atms' ,
method : 'get' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
fetch('https://api.bank.by/atms' ,
{
method : 'GET' ,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'X-Api-Version' => '1.0.0' ,
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.bank.by/atms' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'X-Api-Version' : '1.0.0' ,
'Accept' : 'application/json'
}
r = requests.get('https://api.bank.by/atms' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/atms" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
ATMs
ATMs.
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
X-Api-Version
header
string
false
API version (default latest).
lang
query
string(iso-639-1)(iso-639-1)
false
Language of text data (default belarusan).
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"items" : [
{
"type" : "ATM" ,
"id" : "atm_nbrb_88" ,
"name" : "NBRB #88" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"located_at" : "hall" ,
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"opening_hours" : "Mo-Fr 08:00-20:00" ,
"support_languages" : [
"be" ,
"ru" ,
"en"
],
"supported_currencies" : [
"BYN" ,
"EUR"
],
"supported_services" : [
"show_balance" ,
"cash_withdrawal"
]
}
]
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
This operation does not require authentication
GET /branches
Code samples
curl -X GET https://api.bank.by/branches \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'X-Api-Version: 1.0.0' \
-H 'Accept: application/json'
GET https://api.bank.by/branches HTTP/1.1
Host : api.bank.by
Accept : application/json
Accept : application/json
Content-Type : application/json
X-Api-Version : 1.0.0
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
$.ajax({
url : 'https://api.bank.by/branches' ,
method : 'get' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
fetch('https://api.bank.by/branches' ,
{
method : 'GET' ,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'X-Api-Version' => '1.0.0' ,
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.bank.by/branches' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'X-Api-Version' : '1.0.0' ,
'Accept' : 'application/json'
}
r = requests.get('https://api.bank.by/branches' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/branches" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Branches
Branches.
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
X-Api-Version
header
string
false
API version (default latest).
lang
query
string(iso-639-1)(iso-639-1)(iso-639-1)
false
Language of text data (default belarusan).
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"items" : [
{
"type" : "Branch" ,
"id" : "branch_nbrb_1" ,
"name" : "Main office NBRB" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"note" : null ,
"phone" : "+375173060002" ,
"opening_hours" : "Mo-Th 08:30-17:30, Fr 08:30-16:15" ,
"supported_services" : []
}
]
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
This operation does not require authentication
Account
GET /accounts
Code samples
curl -X GET https://api.bank.by/accounts \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' \
-H 'X-Api-Version: 1.0.0' \
-H 'Accept: application/json'
GET https://api.bank.by/accounts HTTP/1.1
Host : api.bank.by
Accept : application/json
Accept : application/json
Content-Type : application/json
Authorization : Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys
X-Api-Version : 1.0.0
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
$.ajax({
url : 'https://api.bank.by/accounts' ,
method : 'get' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
fetch('https://api.bank.by/accounts' ,
{
method : 'GET' ,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'Authorization' => 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' => '1.0.0' ,
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.bank.by/accounts' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' : '1.0.0' ,
'Accept' : 'application/json'
}
r = requests.get('https://api.bank.by/accounts' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/accounts" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Accounts
List of accounts.
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
Authorization
header
string
true
Authorization (OAuth2 Bearer).
X-Api-Version
header
string
false
API version (default latest).
lang
query
string(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)
false
Language of text data (default belarusan).
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"items" : [
{
"type" : "Account" ,
"id" : "account_d87e183c49b84cbd9ac2e585bdd93896" ,
"iban" : "BY90UNBS30120919200220000840" ,
"bic" : "IRJSBY22" ,
"balance" : "1252.00" ,
"currency" : "BYN"
}
]
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
Status
Header
Type
Format
Description
200
X-Request-Id
string
Request identifiactor.
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: read:accounts )
GET /account/{account_id}/transactions
Code samples
curl -X GET https://api.bank.by/account/{account_id}/transactions \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' \
-H 'X-Api-Version: 1.0.0' \
-H 'Accept: application/json'
GET https://api.bank.by/account/{account_id}/transactions HTTP/1.1
Host : api.bank.by
Accept : application/json
Accept : application/json
Content-Type : application/json
Authorization : Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys
X-Api-Version : 1.0.0
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
$.ajax({
url : 'https://api.bank.by/account/{account_id}/transactions' ,
method : 'get' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'Accept' :'application/json'
};
fetch('https://api.bank.by/account/{account_id}/transactions' ,
{
method : 'GET' ,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'Authorization' => 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' => '1.0.0' ,
'Accept' => 'application/json'
}
result = RestClient.get 'https://api.bank.by/account/{account_id}/transactions' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' : '1.0.0' ,
'Accept' : 'application/json'
}
r = requests.get('https://api.bank.by/account/{account_id}/transactions' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/account/{account_id}/transactions" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Transactions History
Transactions history.
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
Authorization
header
string
true
Authorization (OAuth2 Bearer).
X-Api-Version
header
string
false
API version (default latest).
lang
query
string(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)
false
Language of text data (default belarusan).
account_id
path
string(object-uuid)
true
No description
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"items" : [
{
"type" : "Transaction" ,
"id" : "transaction_85c4b3e76d064fbcb6cebbc38629733d" ,
"from" : {
"iban" : "BY90UNBS30120919200220000840" ,
"name" : "Kanstantyn Mickievich"
},
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
},
"created_at" : "2017-11-26T20:11:28Z"
}
]
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
Status
Header
Type
Format
Description
200
X-Request-Id
string
Request identifiactor.
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: read:transactions )
Payment
POST /account/{account_id}/transactions
Code samples
curl -X POST https://api.bank.by/account/{account_id}/transactions \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' \
-H 'X-Api-Version: 1.0.0' \
-H 'X-Idempotency-Key: string' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json'
POST https://api.bank.by/account/{account_id}/transactions HTTP/1.1
Host : api.bank.by
Content-Type : application/json
Accept : application/json
Accept : application/json
Content-Type : application/json
Authorization : Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys
X-Api-Version : 1.0.0
X-Idempotency-Key : string
var headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'X-Idempotency-Key' :'string' ,
'Content-Type' :'application/json' ,
'Accept' :'application/json'
};
$.ajax({
url : 'https://api.bank.by/account/{account_id}/transactions' ,
method : 'post' ,
headers : headers,
success : function (data ) {
console .log(JSON .stringify(data));
}
})
const request = require ('node-fetch' );
const inputBody = '{
"to": {
"iban": "BY52PJCB30125007521010000840",
"bic": "PJCBBY2X",
"name": "Jan Branislavavich Savicki"
},
"amount": "30.00",
"currency": "BYN",
"charge_policy": "SENDER",
"description": "Act #2 by 08.09.2017",
"metadata": {
"customer_id": "52feca613b844ae8b7ddd627d1fdf58b"
}
}' ;
const headers = {
'Accept' :'application/json' ,
'Content-Type' :'application/json' ,
'Authorization' :'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' :'1.0.0' ,
'X-Idempotency-Key' :'string' ,
'Content-Type' :'application/json' ,
'Accept' :'application/json'
};
fetch('https://api.bank.by/account/{account_id}/transactions' ,
{
method : 'POST' ,
body : inputBody,
headers : headers
})
.then(function (res ) {
return res.json();
}).then(function (body ) {
console .log(body);
});
require 'rest-client'
require 'json'
headers = {
'Accept' => 'application/json' ,
'Content-Type' => 'application/json' ,
'Authorization' => 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' => '1.0.0' ,
'X-Idempotency-Key' => 'string' ,
'Content-Type' => 'application/json' ,
'Accept' => 'application/json'
}
result = RestClient.post 'https://api.bank.by/account/{account_id}/transactions' ,
params: {
}, headers: headers
p JSON.parse(result)
import requests
headers = {
'Accept' : 'application/json' ,
'Content-Type' : 'application/json' ,
'Authorization' : 'Bearer wism73ydof4spe8o92x705t36wbfx41av8bltyys' ,
'X-Api-Version' : '1.0.0' ,
'X-Idempotency-Key' : 'string' ,
'Content-Type' : 'application/json' ,
'Accept' : 'application/json'
}
r = requests.post('https://api.bank.by/account/{account_id}/transactions' , params={
}, headers = headers)
print r.json()
URL obj = new URL("https://api.bank.by/account/{account_id}/transactions" );
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST" );
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null ) {
response.append(inputLine);
}
in.close();
System.out.println(response.toString());
Make Transaction
Make transaction.
Body parameter
{
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
}
}
Parameters
Parameter
In
Type
Required
Description
Accept
header
string
false
Accept response body content type (default application/json).
Content-Type
header
string
false
Request body content type (default application/json).
Authorization
header
string
true
Authorization (OAuth2 Bearer).
X-Api-Version
header
string
false
API version (default latest).
X-Idempotency-Key
header
string
false
Idempotency key.
lang
query
string(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)(iso-639-1)
false
Language of text data (default belarusan).
account_id
path
string(object-uuid)
true
Account identificator.
body
body
TransactionCreate
true
Make opeation.
Enumerated Values
Parameter
Value
Accept
application/json
Content-Type
application/json
lang
be
lang
ru
lang
en-US
Example responses
{
"type" : "Transaction" ,
"id" : "transaction_85c4b3e76d064fbcb6cebbc38629733d" ,
"from" : {
"iban" : "BY90UNBS30120919200220000840" ,
"name" : "Kanstantyn Mickievich"
},
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
},
"created_at" : "2017-11-26T20:11:28Z"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Responses
Status
Header
Type
Format
Description
201
X-Request-Id
string
object-uuid
Request identifiactor.
201
X-Idempotency-Key
string
Idempotency key.
To perform this operation, you must be authenticated by means of one of the following methods:
oauth2 ( Scopes: create:transactions )
Schemas
PostalAddress
{
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
}
Properties
Name
Type
Required
Description
country
string(iso-3166-1)
true
Country code.
state
string
true
State (localisation).
city
string
true
City (localisation).
line
string
true
Address (localisation).
postcode
string
false
Postcode.
GEOJsonPoint
{
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
}
Properties
Name
Type
Required
Description
type
string
true
Type Point
coordinates
[number(float)]
false
longitude, latitude
ATM
{
"type" : "ATM" ,
"id" : "atm_nbrb_88" ,
"name" : "NBRB #88" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"located_at" : "hall" ,
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"opening_hours" : "Mo-Fr 08:00-20:00" ,
"support_languages" : [
"be" ,
"ru" ,
"en"
],
"supported_currencies" : [
"BYN" ,
"EUR"
],
"supported_services" : [
"show_balance" ,
"cash_withdrawal"
]
}
Properties
Name
Type
Required
Description
type
string
true
Type ATM
.
id
string
true
Unique identifier of ATM.
name
string
true
ATM name/ref (localisation).
address
PostalAddress
true
No description
» country
string(iso-3166-1)
true
Country code.
» state
string
true
State (localisation).
» city
string
true
City (localisation).
» line
string
true
Address (localisation).
» postcode
string
false
Postcode.
located_at
string
false
Additional location information (localisation).
location
GEOJsonPoint
true
No description
» type
string
true
Type Point
» coordinates
[number(float)]
false
longitude, latitude
opening_hours
string(opening-hours)
true
Opening hours.
support_languages
[string(iso-639-1)]
false
Support languages.
supported_currencies
[string(iso-4217)]
false
Support currencies.
supported_services
[string]
false
Supported services.
ATMList
{
"items" : [
{
"type" : "ATM" ,
"id" : "atm_nbrb_88" ,
"name" : "NBRB #88" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"located_at" : "hall" ,
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"opening_hours" : "Mo-Fr 08:00-20:00" ,
"support_languages" : [
"be" ,
"ru" ,
"en"
],
"supported_currencies" : [
"BYN" ,
"EUR"
],
"supported_services" : [
"show_balance" ,
"cash_withdrawal"
]
}
]
}
Properties
Name
Type
Required
Description
items
[ATM ]
false
Contains the list of ATMs.
» type
string
true
Type ATM
.
» id
string
true
Unique identifier of ATM.
» name
string
true
ATM name/ref (localisation).
» address
PostalAddress
true
No description
»» country
string(iso-3166-1)
true
Country code.
»» state
string
true
State (localisation).
»» city
string
true
City (localisation).
»» line
string
true
Address (localisation).
»» postcode
string
false
Postcode.
» located_at
string
false
Additional location information (localisation).
» location
GEOJsonPoint
true
No description
»» type
string
true
Type Point
»» coordinates
[number(float)]
false
longitude, latitude
» opening_hours
string(opening-hours)
true
Opening hours.
» support_languages
[string(iso-639-1)]
false
Support languages.
» supported_currencies
[string(iso-4217)]
false
Support currencies.
» supported_services
[string]
false
Supported services.
Branch
{
"type" : "Branch" ,
"id" : "branch_nbrb_1" ,
"name" : "Main office NBRB" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"note" : null ,
"phone" : "+375173060002" ,
"opening_hours" : "Mo-Th 08:30-17:30, Fr 08:30-16:15" ,
"supported_services" : []
}
Properties
Name
Type
Required
Description
type
string
true
Type Branch
.
id
string
true
Unique identifier of branch.
name
string
true
Branch name/ref (localisation).
address
PostalAddress
true
No description
» country
string(iso-3166-1)
true
Country code.
» state
string
true
State (localisation).
» city
string
true
City (localisation).
» line
string
true
Address (localisation).
» postcode
string
false
Postcode.
location
GEOJsonPoint
true
No description
» type
string
true
Type Point
» coordinates
[number(float)]
false
longitude, latitude
note
string
false
Additional location and access information (localisation).
phone
string(phone)
false
Contact phone.
opening_hours
string(opening-hours)
true
Opening hours.
supported_services
[string]
false
Supported operations.
BranchList
{
"items" : [
{
"type" : "Branch" ,
"id" : "branch_nbrb_1" ,
"name" : "Main office NBRB" ,
"address" : {
"country" : "BY" ,
"state" : "Minsk" ,
"city" : "Minsk" ,
"line" : "praspiekt Niezaliežnasci, 20" ,
"postcode" : "220008"
},
"location" : {
"type" : "Point" ,
"coordinates" : [
53.9001189 ,
27.5590155
]
},
"note" : null ,
"phone" : "+375173060002" ,
"opening_hours" : "Mo-Th 08:30-17:30, Fr 08:30-16:15" ,
"supported_services" : []
}
]
}
Properties
Name
Type
Required
Description
items
[Branch ]
false
Contains the list of branches.
» type
string
true
Type Branch
.
» id
string
true
Unique identifier of branch.
» name
string
true
Branch name/ref (localisation).
» address
PostalAddress
true
No description
»» country
string(iso-3166-1)
true
Country code.
»» state
string
true
State (localisation).
»» city
string
true
City (localisation).
»» line
string
true
Address (localisation).
»» postcode
string
false
Postcode.
» location
GEOJsonPoint
true
No description
»» type
string
true
Type Point
»» coordinates
[number(float)]
false
longitude, latitude
» note
string
false
Additional location and access information (localisation).
» phone
string(phone)
false
Contact phone.
» opening_hours
string(opening-hours)
true
Opening hours.
» supported_services
[string]
false
Supported operations.
CurrencyRate
{
"type" : "CurrencyRate" ,
"currency_from" : "EUR" ,
"currency_from_name" : "Euro" ,
"currency_to" : "BYN" ,
"currency_to_name" : "Belarusian ruble" ,
"exchange_rate" : "2.3676"
}
Properties
Name
Type
Required
Description
type
string
true
Type CurrencyRate
.
currency_from
string(iso-4217)
true
Currency ISO 4217 code.
currency_from_name
string
false
Currency name (localisation).
currency_to
string(iso-4217)
true
Currency ISO 4217 code.
currency_to_name
string
false
Currency name (localisation).
exchange_rate
string(decimal)
true
Currency echange rate.
CurrencyRateList
{
"items" : [
{
"type" : "CurrencyRate" ,
"currency_from" : "EUR" ,
"currency_from_name" : "Euro" ,
"currency_to" : "BYN" ,
"currency_to_name" : "Belarusian ruble" ,
"exchange_rate" : "2.3676"
}
]
}
Properties
Name
Type
Required
Description
items
[CurrencyRate ]
false
Contains the list of currencies.
» type
string
true
Type CurrencyRate
.
» currency_from
string(iso-4217)
true
Currency ISO 4217 code.
» currency_from_name
string
false
Currency name (localisation).
» currency_to
string(iso-4217)
true
Currency ISO 4217 code.
» currency_to_name
string
false
Currency name (localisation).
» exchange_rate
string(decimal)
true
Currency echange rate.
Account
{
"type" : "Account" ,
"id" : "account_d87e183c49b84cbd9ac2e585bdd93896" ,
"iban" : "BY90UNBS30120919200220000840" ,
"bic" : "IRJSBY22" ,
"balance" : "1252.00" ,
"currency" : "BYN"
}
Properties
Name
Type
Required
Description
type
string
false
Type Account
id
string(object-uuid)
false
Account identificator.
iban
string(iban)
false
IBAN.
bic
string(bic)
false
BIC.
balance
string(decimal)
false
Balance.
currency
string(iso-4217)
false
Currency ISO 4217 code.
AccountList
{
"items" : [
{
"type" : "Account" ,
"id" : "account_d87e183c49b84cbd9ac2e585bdd93896" ,
"iban" : "BY90UNBS30120919200220000840" ,
"bic" : "IRJSBY22" ,
"balance" : "1252.00" ,
"currency" : "BYN"
}
]
}
Properties
Name
Type
Required
Description
items
[Account ]
false
Countains the list of accounts.
» type
string
false
Type Account
» id
string(object-uuid)
false
Account identificator.
» iban
string(iban)
false
IBAN.
» bic
string(bic)
false
BIC.
» balance
string(decimal)
false
Balance.
» currency
string(iso-4217)
false
Currency ISO 4217 code.
TransactionSender
{
"iban" : "BY90UNBS30120919200220000840" ,
"name" : "Kanstantyn Mickievich"
}
Properties
Name
Type
Required
Description
iban
string(iban)
false
IBAN.
name
string
false
Full name.
TransactionRecipient
{
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
}
Properties
Name
Type
Required
Description
iban
string(iban)
false
IBAN.
bic
string(bic)
false
BIC.
name
string
false
Full name.
TransactionCreate
{
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
}
}
Properties
Name
Type
Required
Description
to
TransactionRecipient
true
No description
» iban
string(iban)
false
IBAN.
» bic
string(bic)
false
BIC.
» name
string
false
Full name.
amount
string(decimal)
true
Transaction amount.
currency
string(iso-4217)
true
Currency ISO 4217 code.
charge_policy
string
false
Charge policy.
description
string
false
Description (optional).
metadata
object
false
Metadata (optional).
Enumerated Values
Property
Value
charge_policy
SHARED
charge_policy
RECEIVER
charge_policy
SENDER
Transaction
{
"type" : "Transaction" ,
"id" : "transaction_85c4b3e76d064fbcb6cebbc38629733d" ,
"from" : {
"iban" : "BY90UNBS30120919200220000840" ,
"name" : "Kanstantyn Mickievich"
},
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
},
"created_at" : "2017-11-26T20:11:28Z"
}
Properties
Name
Type
Required
Description
type
string
false
Type Transaction
id
string(object-uuid)
false
Transaction identificator.
from
TransactionSender
false
No description
» iban
string(iban)
false
IBAN.
» name
string
false
Full name.
to
TransactionRecipient
false
No description
» iban
string(iban)
false
IBAN.
» bic
string(bic)
false
BIC.
» name
string
false
Full name.
amount
string(decimal)
false
Transaction amount
currency
string(iso-4217)
false
Currency ISO 4217 code.
charge_policy
string
false
Charge policy.
description
string
false
Description.
metadata
object
false
Metadata.
created_at
string(date-time)
false
Time when transaction was created.
Enumerated Values
Property
Value
charge_policy
SHARED
charge_policy
RECEIVER
charge_policy
SENDER
TransactionList
{
"items" : [
{
"type" : "Transaction" ,
"id" : "transaction_85c4b3e76d064fbcb6cebbc38629733d" ,
"from" : {
"iban" : "BY90UNBS30120919200220000840" ,
"name" : "Kanstantyn Mickievich"
},
"to" : {
"iban" : "BY52PJCB30125007521010000840" ,
"bic" : "PJCBBY2X" ,
"name" : "Jan Branislavavich Savicki"
},
"amount" : "30.00" ,
"currency" : "BYN" ,
"charge_policy" : "SENDER" ,
"description" : "Act #2 by 08.09.2017" ,
"metadata" : {
"customer_id" : "52feca613b844ae8b7ddd627d1fdf58b"
},
"created_at" : "2017-11-26T20:11:28Z"
}
]
}
Properties
Name
Type
Required
Description
items
[Transaction ]
false
Countains the list of transactions.
» type
string
false
Type Transaction
» id
string(object-uuid)
false
Transaction identificator.
» from
TransactionSender
false
No description
»» iban
string(iban)
false
IBAN.
»» name
string
false
Full name.
» to
TransactionRecipient
false
No description
»» iban
string(iban)
false
IBAN.
»» bic
string(bic)
false
BIC.
»» name
string
false
Full name.
» amount
string(decimal)
false
Transaction amount
» currency
string(iso-4217)
false
Currency ISO 4217 code.
» charge_policy
string
false
Charge policy.
» description
string
false
Description.
» metadata
object
false
Metadata.
» created_at
string(date-time)
false
Time when transaction was created.
Enumerated Values
Property
Value
» charge_policy
SHARED
» charge_policy
RECEIVER
» charge_policy
SENDER
Event
{
"type" : "account.created" ,
"id" : "event_0c7b5bee7b684040939e1a3fb284a87a" ,
"created_at" : "2017-11-26T20:11:28Z" ,
"data" : {
"type" : "Account" ,
"id" : "account_d87e183c49b84cbd9ac2e585bdd93896" ,
"iban" : "BY90UNBS30120919200220000840" ,
"bic" : "IRJSBY22" ,
"balance" : "1252.00" ,
"currency" : "BYN"
}
}
Properties
Name
Type
Required
Description
type
string
false
Event type.
id
string(object-uuid)
false
Event identificator.
created_at
string(date-time)
false
Time when event was created.
data
object
false
Related object data.
» type
string
false
Type Account
» id
string(object-uuid)
false
Account identificator.
» iban
string(iban)
false
IBAN.
» bic
string(bic)
false
BIC.
» balance
string(decimal)
false
Balance.
» currency
string(iso-4217)
false
Currency ISO 4217 code.
» type
string
false
Type Transaction
» id
string(object-uuid)
false
Transaction identificator.
» from
TransactionSender
false
No description
»» iban
string(iban)
false
IBAN.
»» name
string
false
Full name.
» to
TransactionRecipient
false
No description
»» iban
string(iban)
false
IBAN.
»» bic
string(bic)
false
BIC.
»» name
string
false
Full name.
» amount
string(decimal)
false
Transaction amount
» currency
string(iso-4217)
false
Currency ISO 4217 code.
» charge_policy
string
false
Charge policy.
» description
string
false
Description.
» metadata
object
false
Metadata.
» created_at
string(date-time)
false
Time when transaction was created.
Enumerated Values
Property
Value
type
account.created
type
transaction.created
» charge_policy
SHARED
» charge_policy
RECEIVER
» charge_policy
SENDER
Error
{
"code" : "string" ,
"message" : "string" ,
"fields" : "string"
}
Properties
Name
Type
Required
Description
code
string
false
No description
message
string
false
No description
fields
string
false
No description