Tariffs and limits
v1/tariffs/limits/check
/v1/tariffs/limits/checkAuth: Bearer access token — how to use the access token.
Scope: tb:tariffs:read — check whether an operation fits within the client's limits.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| operationName | enum | Required | OUTGOING or INCOMING. | |
| amount | string | Required | Amount to check. | |
| currencyTicker | string | Required | For example USD, EUR. |
/v1/tariffs/limits/checkcurl -G 'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/check' \
-H 'Authorization: Bearer <access-token>' \
-d 'operationName=OUTGOING' \
-d 'amount=500.00' \
-d 'currencyTicker=EUR'
const query = new URLSearchParams({
operationName: 'OUTGOING',
amount: '500.00',
currencyTicker: 'EUR',
});
const response = await fetch(`https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/check?${query}`, {
headers: { Authorization: 'Bearer <access-token>' },
});
const { data } = await response.json();
import requests
response = requests.get(
'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/check',
headers={'Authorization': 'Bearer <access-token>'},
params={'operationName': 'OUTGOING', 'amount': '500.00', 'currencyTicker': 'EUR'},
)
data = response.json()['data']
{
"status": "SUCCESS",
"data": {
"result": true,
"reason": null,
"expect": {
"available": "4500.00",
"min": "1.00",
"max": "10000.00"
},
"source": { "currencyTicker": "EUR", "amount": "500.00" },
"target": { "currencyTicker": "EUR", "amount": "500.00" },
"availableLimits": {
"daily": "4500.00",
"weekly": "20000.00",
"monthly": "50000.00",
"annual": "500000.00"
}
}
}
The parameter is operationName.
Its values are OUTGOING / INCOMING.
v1/tariffs/limits
Limit object
id, clientId, name, description, isBaseCurrency, daily, weekly, monthly, annual, min, max, and available (daily, weekly, monthly, annual).
GET /v1/tariffs/limits
/v1/tariffs/limitsAuth: Bearer access token — how to use the access token.
Query: ids[], clientIds[], pagination[limit], pagination[skip].
/v1/tariffs/limitscurl 'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits' \
-H 'Authorization: Bearer <access-token>'
const response = await fetch('https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits', {
headers: { Authorization: 'Bearer <access-token>' },
});
const { data } = await response.json();
import requests
response = requests.get(
'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits',
headers={'Authorization': 'Bearer <access-token>'},
)
data = response.json()['data']
GET /v1/tariffs/limits/:limitId
/v1/tariffs/limits/:limitIdAuth: Bearer access token — how to use the access token.
/v1/tariffs/limits/:limitIdcurl 'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/<limitId>' \
-H 'Authorization: Bearer <access-token>'
const response = await fetch('https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/<limitId>', {
headers: { Authorization: 'Bearer <access-token>' },
});
const { data } = await response.json();
import requests
response = requests.get(
'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/limits/<limitId>',
headers={'Authorization': 'Bearer <access-token>'},
)
data = response.json()['data']
v1/tariffs/:clientId/current-tariff
/v1/tariffs/:clientId/current-tariffAuth: Bearer access token — how to use the access token.
/v1/tariffs/:clientId/current-tariffcurl 'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/<clientId>/current-tariff' \
-H 'Authorization: Bearer <access-token>'
const response = await fetch('https://sandbox-bank.tedr.com/open-banking/v1/tariffs/<clientId>/current-tariff', {
headers: { Authorization: 'Bearer <access-token>' },
});
const { data } = await response.json();
import requests
response = requests.get(
'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/<clientId>/current-tariff',
headers={'Authorization': 'Bearer <access-token>'},
)
data = response.json()['data']
{
"status": "SUCCESS",
"data": {
"id": "9e6f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
"name": "Standard",
"description": null,
"billingPeriod": "MONTHLY"
}
}
The response contains the tariff itself only.
Limits and fees are requested separately — see limits and fee calculation.
v1/tariffs/fees/calculate
/v1/tariffs/fees/calculateAuth: Bearer access token — how to use the access token.
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| operationName | enum | Required | INCOMING, OUTGOING, STRIPE_SHOPPING or STRIPE_TOP_UP. | |
| amount | string | Required | Amount to calculate the fee for. | |
| currencyTicker | string | Required | For example USD, EUR. | |
| inclusiveInAmount | boolean | Optional | Whether the fee is included in amount. |
/v1/tariffs/fees/calculatecurl -G 'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/fees/calculate' \
-H 'Authorization: Bearer <access-token>' \
-d 'operationName=OUTGOING' \
-d 'amount=100.00' \
-d 'currencyTicker=EUR'
const query = new URLSearchParams({
operationName: 'OUTGOING',
amount: '100.00',
currencyTicker: 'EUR',
});
const response = await fetch(`https://sandbox-bank.tedr.com/open-banking/v1/tariffs/fees/calculate?${query}`, {
headers: { Authorization: 'Bearer <access-token>' },
});
const { data } = await response.json();
import requests
response = requests.get(
'https://sandbox-bank.tedr.com/open-banking/v1/tariffs/fees/calculate',
headers={'Authorization': 'Bearer <access-token>'},
params={'operationName': 'OUTGOING', 'amount': '100.00', 'currencyTicker': 'EUR'},
)
data = response.json()['data']
{
"status": "SUCCESS",
"data": {
"source": {
"currencyTicker": "EUR",
"amount": "100.00",
"totalAmount": "105.00",
"totalFee": "5.00"
},
"target": {
"currencyTicker": "EUR",
"amount": "100.00",
"totalAmount": "105.00",
"totalFee": "5.00"
}
}
}
