This repository was archived by the owner on Aug 26, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Expand file tree
/
Copy pathopenapi.yaml
More file actions
426 lines (426 loc) · 13.5 KB
/
openapi.yaml
File metadata and controls
426 lines (426 loc) · 13.5 KB
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
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
openapi: 3.0.2
servers:
- description: Local development
url: http://localhost:8085
info:
description: Moov Accounts is an HTTP service which represents both a general ledger and chart of accounts for customers. The service is designed to abstract over various core systems and provide a uniform API for developers.
version: 1.0.0
title: Accounts API
contact:
url: "https://groups.google.com/forum/#!forum/moov-users"
license:
name: Apache 2.0
url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
tags:
- name: Accounts
description: |
Accounts endpoints cover both Customers and their Accounts at a Financial Instittuion.
- A customer is a single individual who can own account's. Customers need to be verified via KYC before they can make transactions or own accounts.
- An account is financial institution account associated with a single customer
paths:
/ping:
get:
tags:
- Accounts
summary: Ping Accounts service
description: Check the Accounts service to check if running
operationId: ping
responses:
'200':
description: Service is running properly
/accounts/search:
get:
tags:
- Accounts
summary: Search for Accounts
description: Find accounts which match all specified query parameters
operationId: searchAccounts
parameters:
- name: number
in: query
description: Account number
schema:
type: string
example: 2151
- name: routingNumber
in: query
description: ABA routing number for the Financial Institution
schema:
type: string
example: "69100013"
- name: type
in: query
description: Account type
schema:
type: string
example: Checking
- name: customerID
in: query
description: Customer ID associated to accounts
schema:
type: string
example: cb9012eb
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
example: rs4f9915
schema:
type: string
- name: X-User-ID
in: header
description: Moov User ID header, required in all requests
example: e3cdf999
schema:
type: string
required: true
responses:
'200':
description: An Account object that matches all query parameters
content:
application/json:
schema:
$ref: '#/components/schemas/Accounts'
'404':
description: No account found for provided query parameters
/accounts/transactions:
post:
tags:
- Accounts
summary: Create Transaction
description: |
Post a transaction against multiple accounts. All transaction lines must sum to zero. No money is created or destroyed in a transaction - only moved from account to account. Accounts can be referred to in a Transaction without creating them first.
operationId: createTransaction
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
example: rs4f9915
schema:
type: string
- name: X-User-ID
in: header
description: Moov User ID header, required in all requests
example: e3cdf999
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateTransaction'
example:
lines:
- accountID: entity1
purpose: ACHDebit
amount: 2500
- accountID: entity2
purpose: ACHCredit
amount: 2500
responses:
'200':
description: Transaction successfully created against the account(s)
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
'400':
description: Transaction was not created, see error(s)
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/api/master/openapi-common.yaml#/components/schemas/Error'
/accounts/{accountID}/transactions:
get:
tags:
- Accounts
summary: Get Account transactions
description: Get transactions for an account. Ordered descending from their posted date.
operationId: getAccountTransactions
parameters:
- name: accountID
in: path
description: Account ID
required: true
schema:
type: string
example: 098f3653-1dcb-4358-903e-4c7576f957f6
- name: limit
in: query
description: Maximum number of transactions to return
schema:
type: number
example: 25
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
example: rs4f9915
schema:
type: string
- name: X-User-ID
in: header
description: Moov User ID header, required in all requests
example: e3cdf999
schema:
type: string
required: true
responses:
'200':
description: List of transactions
content:
application/json:
schema:
$ref: '#/components/schemas/Transactions'
example:
lines:
- accountID: entity1
purpose: ACHDebit
amount: 2500
- accountID: entity2
purpose: ACHCredit
amount: 2500
'/accounts/transactions/{transactionID}/reversal':
post:
tags:
- Accounts
summary: Reverse a transaction
description: Reverse a transaction by debiting the credited and crediting the debited amounts among all accounts involved.
operationId: reverseTransaction
parameters:
- name: transactionID
in: path
description: Transaction ID
required: true
schema:
type: string
example: 3e2f66e2
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
example: rs4f9915
schema:
type: string
- name: X-User-ID
in: header
description: Moov User ID header, required in all requests
example: e3cdf999
schema:
type: string
required: true
responses:
'200':
description: Transaction reversal success
content:
application/json:
schema:
$ref: '#/components/schemas/Transaction'
example:
lines:
- accountID: entity1
purpose: ACHDebit
amount: 2500
- accountID: entity2
purpose: ACHCredit
amount: 2500
'400':
description: Unable to reverse the specified transaction, check error(s).
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/api/master/openapi-common.yaml#/components/schemas/Error'
/accounts:
post:
tags:
- Accounts
summary: Create Account
description: Create an account for a Customer. Leaving the number blank will generate a random value.
operationId: createAccount
parameters:
- name: X-Request-ID
in: header
description: Optional Request ID allows application developer to trace requests through the systems logs
example: rs4f9915
schema:
type: string
- name: X-User-ID
in: header
description: Moov User ID header, required in all requests
example: e3cdf999
schema:
type: string
required: true
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/CreateAccount'
responses:
'200':
description: The created Account model
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
'400':
description: Invalid user information, check error(s).
content:
application/json:
schema:
$ref: 'https://raw.githubusercontent.com/moov-io/api/master/openapi-common.yaml#/components/schemas/Error'
'500':
description: 'Internal error, check error(s) and report the issue.'
components:
schemas:
CreateAccount:
type: object
required:
- customerID
- balance
- name
- type
properties:
customerID:
type: string
description: Customer ID associated with accounts
example: 0c584689
balance:
type: integer
description: Initial balance of account in USD cents. This amount is to be deposited from an account at another Financial Institution or in-person (i.e. cash) on account creation.
example: 1000
name:
type: string
description: Caller defined label for this account.
example: Super Checking
number:
type: string
description: Random number to be used as unique to distinguish this Account
example: 12345
type:
type: string
description: Product type of the account
enum:
- Checking
- Savings
- FBO
Account:
type: object
properties:
ID:
type: string
format: uuid
description: The unique identifier for an account
example: d290f1ee-6c54-4b01-90e6-d701748f0851
customerID:
type: string
format: uuid
description: The unique identifier for the customer who owns the account
example: e210a9d6-d755-4455-9bd2-9577ea7e1081
name:
type: string
description: Caller defined label for this account.
example: Super Checking
accountNumber:
type: string
description: A unique Account number at the bank.
minimum: 8
maximum: 17
example: 987654321
accountNumberMasked:
type: string
description: Last four digits of an account number
minimum: 4
maximum: 4
example: 4321
routingNumber:
type: string
description: Routing Transit Number is a nine-digit number assigned by the ABA
minimum: 9
maximum: 9
example: "073000176"
status:
type: string
description: Status of the account being created.
enum:
- Open
- Closed
type:
type: string
description: Product type of the account
enum:
- Checking
- Savings
- FBO
createdAt:
type: string
format: date-time
example: '2016-08-29T09:12:33.001Z'
closedAt:
type: string
format: date-time
example: '2019-01-2T09:12:33.001Z'
lastModified:
type: string
format: date-time
description: Last time the object was modified except balances
example: '2016-08-29T09:12:33.001Z'
balance:
type: integer
description: Total balance of account in USD cents.
example: 1000
balanceAvailable:
type: integer
description: Balance available in USD cents to be drawn
example: 850
balancePending:
type: integer
description: Balance of pending transactions in USD cents
example: 100
Accounts:
type: array
items:
$ref: '#/components/schemas/Account'
CreateTransaction:
properties:
lines:
type: array
items:
$ref: '#/components/schemas/TransactionLine'
Transaction:
properties:
ID:
type: string
description: Unique ID of a transaction
example: 140fa826
timestamp:
type: string
format: date-time
example: 2006-01-02T15:04:05Z07:00
lines:
type: array
items:
$ref: '#/components/schemas/TransactionLine'
Transactions:
type: array
items:
$ref: '#/components/schemas/Transaction'
TransactionLine:
properties:
accountID:
type: string
description: Account ID
example: baa835b8
purpose:
type: string
enum:
- Transfer
- Fee
- Interest
- Wire
- ACHDebit
- ACHCredit
amount:
type: number
description: Change in account balance (in USD cents)
example: 2500