Skip to content

Commit 7084033

Browse files
committed
Update README
1 parent a0a3ec0 commit 7084033

File tree

1 file changed

+76
-60
lines changed

1 file changed

+76
-60
lines changed

README.md

Lines changed: 76 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -25,88 +25,104 @@ This framework is published at the TestPyPI, install it with pip:
2525
Get currencies
2626
```python
2727
>>> mng.get_currency()
28-
[
29-
{
30-
"currencyCodeA": 840,
31-
"currencyCodeB": 980,
32-
"date": 1702591273,
33-
"rateBuy": 36.95,
34-
"rateSell": 37.4406
35-
},
36-
{
37-
"currencyCodeA": 978,
38-
"currencyCodeB": 980,
39-
"date": 1702623973,
40-
"rateBuy": 40.35,
41-
"rateSell": 41.1404
42-
},
43-
{
44-
"currencyCodeA": 978,
45-
"currencyCodeB": 840,
46-
"date": 1702623973,
47-
"rateBuy": 1.086,
48-
"rateSell": 1.1025
49-
},
50-
...
51-
]
28+
{
29+
"code": 200,
30+
"detail":
31+
[
32+
{
33+
"currencyCodeA": 840,
34+
"currencyCodeB": 980,
35+
"date": 1702591273,
36+
"rateBuy": 36.95,
37+
"rateSell": 37.4406
38+
},
39+
{
40+
"currencyCodeA": 978,
41+
"currencyCodeB": 980,
42+
"date": 1702623973,
43+
"rateBuy": 40.35,
44+
"rateSell": 41.1404
45+
},
46+
{
47+
"currencyCodeA": 978,
48+
"currencyCodeB": 840,
49+
"date": 1702623973,
50+
"rateBuy": 1.086,
51+
"rateSell": 1.1025
52+
},
53+
...
54+
]
55+
}
5256
```
5357

5458
Get client info
5559
```python
5660
>>> mng.get_client_info()
5761
{
58-
"clientId": "xxxxxxxxxx",
59-
"name": "Last name First name",
60-
"webHookUrl": "",
61-
"permissions": "psfj",
62-
"accounts": [
62+
"code": 200,
63+
"detail":
6364
{
64-
"id": "xxxxxxxxxxxxxxxxxxx",
65-
"sendId": "xxxxxxxxxx",
66-
"currencyCode": 980,
67-
"cashbackType": "UAH",
68-
"balance": xxxxx,
69-
"creditLimit": 0,
70-
"maskedPan": [
71-
"xxxxxx******xxxx"
72-
],
73-
"type": "black",
74-
"iban": "UAxxxxxxxxxxxxxxxxxxxxxxxxxxx"
65+
"clientId": "xxxxxxxxxx",
66+
"name": "Last name First name",
67+
"webHookUrl": "",
68+
"permissions": "psfj",
69+
"accounts": [
70+
{
71+
"id": "xxxxxxxxxxxxxxxxxxx",
72+
"sendId": "xxxxxxxxxx",
73+
"currencyCode": 980,
74+
"cashbackType": "UAH",
75+
"balance": xxxxx,
76+
"creditLimit": 0,
77+
"maskedPan": [
78+
"xxxxxx******xxxx"
79+
],
80+
"type": "black",
81+
"iban": "UAxxxxxxxxxxxxxxxxxxxxxxxxxxx"
82+
}
83+
]
7584
}
76-
]
7785
}
7886
```
7987

8088
Get balance
8189
```python
8290
>>> mng.get_balance()
8391
{
84-
"balance": x.xx
92+
"code": 200,
93+
"detail":
94+
{
95+
"balance": x.xx
96+
}
8597
}
8698
```
8799

88100
Get statement
89101
```python
90102
>>> period = 31
91103
>>> mng.get_statement(period)
92-
[
93-
{
94-
"id": "xxxxxxxxxxxxxxxxxx",
95-
"time": xxxxxxxxxx,
96-
"description": "xxxx xxxxx",
97-
"mcc": xxxx,
98-
"originalMcc": xxxx,
99-
"amount": -xxxxx,
100-
"operationAmount": -xxxxx,
101-
"currencyCode": xxx,
102-
"commissionRate": x,
103-
"cashbackAmount": xxx,
104-
"balance": xxxx,
105-
"hold": false,
106-
"receiptId": "xxxx-xxxx-xxxx-xxxx"
107-
},
108-
...
109-
]
104+
{
105+
"code": 200,
106+
"detail":
107+
[
108+
{
109+
"id": "xxxxxxxxxxxxxxxxxx",
110+
"time": xxxxxxxxxx,
111+
"description": "xxxx xxxxx",
112+
"mcc": xxxx,
113+
"originalMcc": xxxx,
114+
"amount": -xxxxx,
115+
"operationAmount": -xxxxx,
116+
"currencyCode": xxx,
117+
"commissionRate": x,
118+
"cashbackAmount": xxx,
119+
"balance": xxxx,
120+
"hold": false,
121+
"receiptId": "xxxx-xxxx-xxxx-xxxx"
122+
},
123+
...
124+
]
125+
}
110126
```
111127

112128
Create a Webhook

0 commit comments

Comments
 (0)