https://github.com/redmadrobot/omega-bank-mock
https://github.com/redmadrobot/omega-bank-mock
api json mock rest rest-api
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/redmadrobot/omega-bank-mock
- Owner: RedMadRobot
- Created: 2021-04-22T07:32:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-14T18:07:13.000Z (almost 4 years ago)
- Last Synced: 2025-01-16T05:55:07.865Z (3 months ago)
- Topics: api, json, mock, rest, rest-api
- Language: Python
- Homepage:
- Size: 155 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Моковый сервер для проекта Омега Банк
Базовый URL
```
https://omegabank.mock-object.redmadserver.com/api/v1
```
## Авторизация
Механизм аутентификации - Bearer.
В авторизованной зоне, в каждый запрос необходимо добавить http заголовок с токеном, полученный в запросе `/auth/sms/check-code`.
```
Authorization: Bearer
```
### Запросить смс-код по номеру телефона
```
POST /auth/sms/send-code
```
Подробнее...
Запрос:
```json
{
"phone_number": "79991112233"
}
```
Ответ:
```json
{
"data": {
"retry_interval": 60
}
}
```
### Проверить код
```
POST /auth/sms/check-code
```
Подробнее...
Запрос:
```json
{
"phone_number": "79991112233",
"code": "1234"
}
```
Ответ:
```json
{
"data": {
"access_token": "406A143A-A460-4A05-BF26-C28D7D04F129",
"refresh_token": "921F7D7A-CB3A-4681-9B93-5A2FD4B46553",
"expires_in": 86400
}
}
```
### Получить профиль пользователя
```
GET /auth/profile
```
Подробнее...
Ответ:
```json
{
"data": {
"user": {
"user_id": 9703,
"full_name": "Тестовый Тест Тестович",
"phone": "79991112233",
"email": "[email protected]"
}
}
}
```
## Точки пополнения банковского счета
### Получить список точек
```
GET /deposition-points
```
Подробнее...
Ответ:
```json
{
"data": {
"points": [
{
"externalId": "17971",
"partnerName": "MTSBank",
"location": {
"latitude": 55.7570521,
"longitude": 37.61711
},
"workHours": "ПН-ВС 08:00-22:00",
"phones": "+7(495)921-28-00",
"fullAddress": "г Москва, ул Охотный Ряд, д 2"
},
]
}
}
```
### Получить информацию о партнерах
```
GET /deposition-partners
```
Подробнее...
Ответ:
```json
{
"data": {
"partners": [
{
"id": "MKB",
"name": "МКБ",
"picture": "",
"url": "",
"hasLocations": true,
"isMomentary": false,
"depositionDuration": "",
"limitations": "",
"pointType": "",
"externalPartnerId": "220",
"description": "",
"moneyMin": 10,
"moneyMax": 300000,
"hasPreferentialDeposition": false,
"limits": [
{
"currency": {
"code": 643,
"name": "RUB",
"strCode": "643"
},
"min": 10,
"max": 300000
}
],
"dailyLimits": [
{
"currency": {
"code": 643,
"name": "RUB",
"strCode": "643"
},
"amount": 300000
}
]
}
]
}
}
```
## Получение списков банковских продуктов
### Получить информацию о картах
```
GET /cards
```
Подробнее...
Ответ:
```json
{
"data": {
"cards": [
{
"id": 1,
"name": "Visa Classic",
"number": "NDSL RA01 203 4455 12",
"value": 1233
},
{
"id": 2,
"name": "Visa Classic",
"number": "NDSL RA01 203 4455 13",
"value": 5234
},
{
"id": 3,
"name": "Visa Gold",
"number": "NDSL RA01 203 4455 14",
"value": 6225
},
{
"id": 4,
"name": "Visa Platinum",
"number": "NDSL RA01 203 4455 15",
"value": 8885
}
]
}
}
```
Curl пример:
```
curl http://127.0.0.1:5000/api/v1/cards
```
### Получить информацию о счетах
```
GET /deposits
```
Подробнее...
Ответ:
```json
{
"data": {
"deposits": [
{
"id": 5,
"name": "Platinum",
"number": "NDSL RA01 203 4455 01",
"value": 30234
},
{
"id": 6,
"name": "Package",
"number": "NDSL RA01 203 4455 02",
"value": 12976
},
{
"id": 7,
"name": "Elite",
"number": "NDSL RA01 203 4455 03",
"value": 51234
},
{
"id": 8,
"name": "Platinum",
"number": "NDSL RA01 203 4455 04",
"value": 73417
}
]
}
}
```
Curl пример:
```
curl http://127.0.0.1:5000/api/v1/deposits
```
## Регистрация новых банковских продуктов
### Зарегистрировать новую карту
```
POST /cards
```
Подробнее...
Получить список всех типов карт можно [тут](#получение-списка-всех-типов-карт)
Запрос:
```json
{
"type": "classic"
}
```
Ответ:
```json
{
"data": {
"card": {
"id": 5,
"name": "Visa Gold",
"number": "NDSL RA01 203 4455 16",
"value": 1117
}
}
}
```
Curl пример:
```
curl -d '{"type":"classic"}' -H "Content-Type: application/json" -X POST http://127.0.0.1:5000/api/v1/cards
```
### Получение списка всех типов карт
```
GET /card-types
```
Подробнее...
Ответ:
```json
{
"data": {
"types": [
{
"code": "classic",
"name": "Classic",
"about": [
{
"caption": "INTRO PURCHASE APR",
"value": "N/A"
},
{
"caption": "REGULAR PURCHASE APR",
"value": "15.99%-22.99% Variable"
},
{
"caption": "INTRO BALANCE TRANSFER APR",
"value": "N/A"
},
{
"caption": "ANNUAL FEE",
"value": "$95"
}
]
},
{
"code": "gold",
"name": "Gold",
"about": [
{
"caption": "INTRO PURCHASE APR",
"value": "N/A"
},
{
"caption": "REGULAR PURCHASE APR",
"value": "17.99%-23.99% Variable"
},
{
"caption": "INTRO BALANCE TRANSFER APR",
"value": "N/A"
},
{
"caption": "ANNUAL FEE",
"value": "$0-$99"
}
]
},
{
"code": "platinum",
"name": "Platinum",
"about": [
{
"caption": "INTRO PURCHASE APR",
"value": "N/A"
},
{
"caption": "REGULAR PURCHASE APR",
"value": "19.99%-25.99% Variable"
},
{
"caption": "INTRO BALANCE TRANSFER APR",
"value": "N/A"
},
{
"caption": "ANNUAL FEE",
"value": "$0-$99"
}
]
}
]
}
}
```
Curl пример:
```
curl http://127.0.0.1:5000/api/v1/card-types
```
### Открыть новый счет
```
POST /deposits
```
Подробнее...
Получить список всех типов счетов можно [тут](#получение-списка-всех-типов-счетов)
Запрос:
```json
{
"type": "package"
}
```
Ответ:
```json
{
"data": {
"deposit": {
"id": 9,
"name": "Platinum",
"number": "NDSL RA01 203 4455 05",
"value": 25
}
}
}
```
Curl пример:
```
curl -d '{"type":"package"}' -H "Content-Type: application/json" -X POST http://127.0.0.1:5000/api/v1/deposits
```
### Получение списка всех типов счетов
```
GET /deposit-types
```
Подробнее...
Ответ:
```json
{
"data": {
"types": [
{
"code": "platinum",
"name": "Platinum",
"description": "Exclusive savings account for our Platinum Checking Package customers",
"about": [
{
"caption": "MONTHLY MAINTENANCE FEE",
"value": "$0"
},
{
"caption": "MINIMUM OPENING DEPOSIT",
"value": "$25"
}
]
},
{
"code": "package",
"name": "Package Money Market Savings",
"description": "Competitive savings account rates only for Gold Checking Package customers",
"about": [
{
"caption": "MONTHLY MAINTENANCE FEE",
"value": "$0"
},
{
"caption": "MINIMUM OPENING DEPOSIT",
"value": "$25"
}
]
},
{
"code": "elite",
"name": "Elite Money Market Account",
"description": "Earn more interest on high balance accounts",
"about": [
{
"caption": "MONTHLY MAINTENANCE FEE",
"value": "$10"
},
{
"caption": "MINIMUM OPENING DEPOSIT",
"value": "$100"
}
]
},
{
"code": "standard",
"name": "Standard Savings Account",
"description": "Basic savings ideal for low balances and first-time savers",
"about": [
{
"caption": "MONTHLY MAINTENANCE FEE",
"value": "$4"
},
{
"caption": "MINIMUM OPENING DEPOSIT",
"value": "$25"
}
]
},
{
"code": "retirement",
"name": "Retirement Money Market",
"description": "An easy way to diversify your U.S. Bank portfolio with valuable tax advantages",
"about": [
{
"caption": "MONTHLY MAINTENANCE FEE",
"value": "$0"
},
{
"caption": "MINIMUM OPENING DEPOSIT",
"value": "$100"
}
]
}
]
}
}
```
Curl пример:
```
curl http://127.0.0.1:5000/api/v1/deposit-types
```