-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger SA CIB Account Information.json
386 lines (386 loc) · 16 KB
/
swagger SA CIB Account Information.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
{
"openapi": "3.0.0",
"servers": [
{
"url": "http://api.investec.com",
"description": "",
"variables": {}
}
],
"info": {
"version": "1.0.0",
"title": "SA CIB Account Information",
"description": "The CIB account information API allows Investec SA Corporate and institutional clients to access their account and transactional information (read-only) via an API. \n \nIt can be used to retrieve account information such as:\n\n* Account and balance details\n* Account transactions\n \n\nThere are many possible use cases for the Account Information API: from extracting the data to aggregate it with financial data from other banking institutions to personal money management tools. \n\n**Release Notes**\n\n 2023-06-21\n\n* **Enhancement**: Added a sandbox environment \n\n \n# Sandbox\n\nTo use the sandbox environment use the base url `https://openapisandbox.investec.com` for authentication and all subsequent api requests. \n\n Authenticating: \n* **Auth URL (POST):** `https://openapisandbox.investec.com/identity/v2/oauth2/token` \n* **header** `Authorization: Basic QXVQd2poU3k3a2FVd2djaDJJc0xGR1FPRUV4QVppaDU6N3ljWVhLYWtHZDZBU002Zg==` \n* **header** `x-api-key: QXVQd2poU3k3a2FVd2djaDJJc0xGR1FPRUV4QVppaDU6YVc1MlpYTjBaV010ZW1FdFkybGlMV0ZqWTI5MWJuUnpMWE5oYm1SaWIzZz0=` \n* **header** `Content-Type: application/x-www-form-urlencoded` \n* **data-urlencode** `grant_type=client_credentials` \n\n The basic authorization header are as follows ( *clientId:* `AuPwjhSy7kaUwgch2IsLFGQOEExAZih5` *secret:* `7ycYXKakGd6ASM6f` ) Eg. Base64-encode ( {clientId}:{secret} )\n\n# Authentication\n\n<!-- ReDoc-Inject: <security-definitions> -->",
"termsOfService": "https://developer.investec.com/za/terms-of-use",
"contact": {}
},
"paths": {
"/za/bb/v1/accounts": {
"get": {
"summary": "Get Accounts",
"description": "Obtain a list of accounts with balances in associated profile.",
"operationId": "Accounts",
"parameters": [],
"responses": {
"200": {
"description": "The requested operation was successfully completed",
"content": {
"application/json": {
"example": {
"data": {
"accounts": [
{
"AccountHolderAddress": {
"AddressLine1": "",
"AddressLine2": "",
"City": "",
"Country": "",
"CountryCode": ""
},
"RoutingBIC": "",
"BankAccountProductType": "",
"CreditLastCycleToNextBusinessDate": "0001-01-01T00:00:00",
"CustomerAccountType": "",
"DebitLastCycleToNextBusinessDate": "0001-01-01T00:00:00",
"DueDateOfPayment": "0001-01-01T00:00:00",
"MinimumAmountLimit": 0,
"NumberOfCardHolders": 0,
"CreditLimit": 0,
"DebitAccountBankName": "",
"PendingTransactions": 0,
"Banks": {
"Name": "Investec South Africa",
"ChipsUID": "",
"Branch": [
{
"Number": ""
}
],
"PostalAddress": {
"AddressLine1": "100 Grayston drive",
"AddressLine2": "Sandown",
"City": "",
"Country": null
}
},
"Currencies": {
"CurrencyCode": "USD"
},
"InterestDistribution": "",
"NoticesBalance": 0,
"AccountOpenDate": "2021-10-13T07:19:01Z",
"CumulativeNoticesAmount": 0,
"InstantAvailableNoticeBalance": 0,
"MinimimAmountLimit": 0,
"loggedOnUser": {
"UserFirstName": "Jane",
"UserLastName": "Doe",
"UserCompany": "Racing Stripes Test Account FBCC (Pty) Ltd BTB TEST"
},
"NoticeInterestNominated": 0,
"NoticeInterestBank": "",
"noticeInterestAccountName": "",
"NoticeInterestAccount": "",
"PreviousStatementPeriod": "0001-01-01T00:00:00",
"DebitAccountNumber": "",
"DealReference": "",
"AutomaticPaymentOrder": "0.00000",
"BackOfficeCustomerCode": "RACINGSTRIPESPTYCALYPSO",
"AccountId": "4407",
"AccountName": "USD 6566939 Term Deposit Account",
"AccountFullName": "",
"AccountType": "Term Deposit Account",
"AccountTypeId": "5",
"AccountNumber": "6566939",
"AlternativeAccNo": "",
"ElectronicAccountNumber": "",
"Balances": {
"CapitalBalance": 12,
"AvailableBalance": 0,
"PrincipalAmount": 0,
"ValueDate": "2020-06-03T22:00:01Z",
"ClosingBalance": 0,
"PendingCardBalance": 0
},
"BackOfficeType": "",
"Products": {
"StartDate": "0001-01-01T00:00:00",
"EndDate": "0001-01-01T00:00:00",
"OverdraftLimit": 0,
"MaxTransferLimit": 0
},
"Description": "RACING STRIPES (PTY) LIMITED",
"OwnerType": "1",
"Interests": {
"Amount": 0,
"Rate": 0,
"RateMaturity": 0,
"RateCredit": 0.0155,
"RateDebit": 0,
"AccruedCreditInterest": 0,
"AccruedDebitInterest": 0
},
"ActiveFlag": "Y",
"NickName": "RACING STRIPES (PTY) LIMITED",
"CreatedDate": "2021-10-12T22:00:01Z",
"ModifiedDate": "0001-01-01T00:00:00",
"MaturityAmount": 0,
"StatementFrequency": "",
"StatementNumber": "",
"StatementDay": "0",
"StatementMonth": "",
"EmailAddress": "",
"Category": "Invest",
"LinkedAccount": "",
"AccountFormat": "99"
}
]
},
"links": {
"self": "https://openapi.investec.com/za/bb/v1/accounts"
},
"meta": {
"totalPages": 1
}
}
}
}
},
"400": {
"description": "Bad Request - The requested operation will not be carried out"
},
"401": {
"description": "Unauthorized - The requested operation was refused access"
},
"403": {
"description": "Forbidden - Not permitted to make this request"
},
"429": {
"description": "Too Many Requests - To many requests in quick succession, Retry the request."
},
"500": {
"description": "Internal Server Error - The requested operation failed to execute"
}
},
"requestBody": {
"content": {
"application/text": {
"example": "GET https://openapi.investec.com/za/bb/v1/accounts HTTP/1.1 \nAuthorization: Basic e2NsaWVudElkfTp7c2VjcmV0fQ== \nHost: openapi.investec.com \nAccept: application/json \n\n $.ajax({ \n url: 'https://openapi.investec.com/za/bb/v1/accounts',\n type: 'GET', \n headers: {\n 'Authorization': 'Basic e2NsaWVudElkfTp7c2VjcmV0fQ=='\n },\n success: function (result) {\n console.log(JSON.stringify(result));\n }\n});"
}
}
}
}
},
"/za/bb/v1/accounts/{accountId}/transactions?fromDate={fromDate}&toDate={toDate}&page=1": {
"get": {
"summary": "Get Account Transactions",
"description": "Obtain a specified account's transactions.",
"operationId": "AccountsTransactions",
"parameters": [
{
"in": "path",
"name": "accountId",
"description": "AccountId Id",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/fromDate"
},
{
"$ref": "#/components/parameters/toDate"
},
{
"$ref": "#/components/parameters/page"
}
],
"responses": {
"200": {
"description": "Resource has been retrieved",
"content": {
"application/json": {
"example": {
"data": {
"transactions": [
{
"AccountName": "ZAR 1300206346580 Investec Business Account",
"TransactionCode": "284",
"TransactionStatus": "approved",
"InvestmentDate": "0001-01-01T00:00:00",
"InvestmentName": null,
"InvestmentStatus": null,
"RemainingTerm": null,
"InvestmentAmount": null,
"StatementId": "51599",
"InstantAccessBalance": null,
"BranchCode": null,
"AccountNumber": null,
"DistributionAccount": null,
"AccountType": null,
"PostDate": "0001-01-01T00:00:00",
"Interest": null,
"AccruedInterest": null,
"MaturityDate": "0001-01-01T00:00:00",
"BankName": null,
"CustomerReferenceId": "",
"BackOfficeReferenceId": "",
"CardNumber": "Internal-Live",
"TransactionId": "202105180000000000284",
"Reference": "INVBUSONLBENEFRENSD",
"Beneficiaries": {
"LinkList": null,
"Entities": {
"EntityName": "Internal Transaction DETAIL - 40005030601"
}
},
"Description": "Internal Transaction",
"Accounts": {
"AccountId": 73,
"AccountNumber": "1300206346580"
},
"Currencies": {
"CurrencyCode": "ZAR"
},
"CaptureDate": "2021-05-17T22:00:01Z",
"ValueDate": "2021-05-17T22:00:01Z",
"CardHolderName": "INVBUSONLBENEFRENSD",
"AutoForwardProcessingDate": false,
"Amount": 5000,
"Reference_1": "PMC Inbounds",
"Reference_2": "",
"Reference_3": "DETAIL - 40005030601",
"Reference_4": null,
"Reference_5": null,
"Reference_8": "614",
"Reference_9": "BENEFRENSD",
"Reference_10": "",
"RunningBalance": 5445059.76
}
]
},
"links": {
"self": "https://openapi.investec.com/za/bb/v1/accounts/{accountId}/transactions?fromDate={fromDate}&toDate={toDate}&page={page}"
},
"meta": {
"totalPages": 1
}
}
}
}
},
"400": {
"description": "Bad Request - The requested operation will not be carried out"
},
"401": {
"description": "Unauthorized - The requested operation was refused access"
},
"403": {
"description": "Forbidden - Not permitted to make this request"
},
"429": {
"description": "Too Many Requests - To many requests in quick succession, Retry the request."
},
"500": {
"description": "Internal Server Error - The requested operation failed to execute"
}
},
"requestBody": {
"content": {
"application/text": {
"example": "GET https://openapi.investec.com/za/bb/v1/accounts/{accountId}/transactions?fromDate={fromDate}&toDate={toDate}&page={page} HTTP/1.1 \nAuthorization: Basic e2NsaWVudElkfTp7c2VjcmV0fQ== \nHost: openapi.investec.com \nAccept: application/json \n\n $.ajax({ \n url: 'https://openapi.investec.com/za/bb/v1/accounts/{accountId}/transactions?fromDate={fromDate}&toDate={toDate}&page={page}',\n type: 'GET', \n headers: {\n 'Authorization': 'Basic e2NsaWVudElkfTp7c2VjcmV0fQ=='\n },\n success: function (result) {\n console.log(JSON.stringify(result));\n }\n});"
}
}
}
}
}
},
"components": {
"securitySchemes": {
"bearer": {
"type": "http",
"scheme": "bearer"
}
},
"parameters": {
"x-api-key": {
"name": "x-api-key",
"in": "header",
"required": true,
"style": "simple",
"schema": {
"type": "string",
"example": "{{x-api-key}}"
}
},
"fromDate": {
"name": "fromDate",
"description": "Refers to the date range filter's start date. Will default to today's date, minus 180 days, if not specified.",
"in": "query",
"required": false,
"style": "form",
"schema": {
"type": "string",
"example": "2021-05-01"
}
},
"toDate": {
"name": "toDate",
"description": "Refers to the date range filter's end date. Will default to today's date if not specified.",
"in": "query",
"required": false,
"style": "form",
"schema": {
"type": "string",
"example": "2021-06-01"
}
},
"page": {
"name": "page",
"description": "Refers to the page number.",
"in": "query",
"required": false,
"style": "form",
"schema": {
"type": "string",
"example": "1"
}
}
},
"schemas": {
"MetaData": {
"description": "Meta Data relevant to the payload",
"type": "object",
"properties": {
"TotalPages": {
"format": "int32",
"type": "integer"
}
}
},
"Links": {
"description": "Links relevant to the payload",
"required": [
"Self"
],
"type": "object",
"properties": {
"Self": {
"type": "string"
}
}
}
}
},
"security": [
{
"bearer": []
}
],
"tags": [],
"externalDocs": {
"url": "",
"description": ""
}
}