-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
9518 lines (9197 loc) · 284 KB
/
openapi.yaml
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
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.3
info:
title: Jiko Partner API
description: >
# Introduction
Welcome to the Jiko API Reference! Jiko enables you to integrate money
storage and movement, backed by the safety and security of US Treasury
Bills.
</br>
At the core of our platform is the Jiko account: a pair consisting of a bank
account and a brokerage account. When money is deposited into an account,
the funds are automatically invested in T-bills. When a payment or
withdrawal is made, T-bills are immediately liquidated and used as cash.
Customers can have multiple accounts, and each account is associated with a
single T-bill maturity: 4-week, 13-week, 26-week or 52-week.
</br>
The API Reference covers everything you need to build a full application
leveraging the Jiko platform:
</br>
- Onboarding customers
- Funding customer accounts via ACH or Wire
- Viewing and managing accounts (including monthly statements and trade
confirmations)
- Making payments and transfers via ACH, Wire, On-Us (Book) Transfer or
Debit Card
</br>
When you’re ready to start building, please contact us at
[partner.support@jiko.io](mailto:partner.support@jiko.io) to request sandbox
access.
# Partner obligations
</br>
- Before onboarding, the end-user’s control over any email addresses or
phone numbers must be confirmed (for example, via confirmation codes) before
submitting an application to the API.
- While onboarding, partners must comply with the disclosure requirements
listed [below](https://docs.jiko.io/reference).
- Monthly statements are created for bank and brokerage accounts and must be
made available to the user.
- Partners are required to send an email to end users every month a new statement is available to comply with regulatory requirements.
- Partners can expect monthly statements to be available by the 15th of every month.
- It is required to make the past 6 years of brokerage statements available to the end user.
- It is advised to make at least the past 12 months of bank statements available to the end user.
- Trade confirmations must be made available to the user.
## Disclosures and Agreements
- The bundle of customer disclosures and agreements served at the
[Agreements](https://docs.jiko.io/reference) endpoint must be presented to
users before signing up for an account.
This includes Risk and Limitation disclosures, Regulation E disclosures, Account agreements and more.
- The customer consent for these disclosures have to be versioned and time-stamped and sent with the application.
- Jiko reserves the right to update agreements from time to time.
If a change is _adverse_ to the customer, Jiko will notify partners, and they are then required to notify their end users 30 days in advance of the change.
- A change is deemed to be _adverse_ to the customer if it will result in increased fees, increased liability for the customer, fewer types of available transactions or stricter limitations on the frequency or dollar amount of transactions.
- When Jiko updates the bundle of agreements, the version number of the
agreement bundle will increment.
Jiko reserves the right to reject or manually review applications where customer consent does not match the latest agreement version.
Partners must re-fetch and display the agreements and disclosures links from the Agreements endpoint for every new application. This ensures each applicant is served the latest version of the agreements.
# Authentication
**Jiko** provides partners with a `username` and a `password`, as well as a
`shared secret`. Partners are provided with a `bearer token` in the
[Login](https://docs.jiko.io/reference) response, which must be sent with
each request.
</br>
Each request made to the partner API needs 3 parts in order for it to be
processed:
1. An **Authorization** HTTP header containing the value
```javascript
Bearer <access_token>
```
</br>
Where the `access_token` is the bearer token given in the
[Login](https://docs.jiko.io/reference) response.
1. An **x-jiko-idempotency** HTTP header set to a random uuid for this
action, in order to signify a unique request to the API from the partner’s
perspective.
2. An **x-jiko-signature** HTTP header set to a base64 encoded HMAC-SHA256
hash of `x-jiko-idempotency+request pathname+body` using the shared secret
as a key.
Below is a Node.js example showing how a potential request could be signed:
</br>
```javascript
const crypto = require("crypto");
const uuid = require("uuid");
const idempotency = uuid.v4();
const pathname = "/api/v1/agreements/";
const body = "";
request.headers["x-jiko-signature"] = crypto
.createHmac("sha256", "shared-secret-here")
.update(idempotency + pathname + body, "utf-8")
.digest("base64");
```
</br>
**Partner** requests will need to be sent from an IP address whitelisted by
**Jiko**.
**Jiko** will verify the request signature by repeating the steps above,
additionally checking for possible repeated requests. A request is
considered to be repeated if the idempotency key value provided in the
`x-jiko-idempotency` header has been used previously in the past 1 hour.
</br>
Bearer tokens have a lifetime of 60 minutes.
The partner will need to repeat the login process once a token has expired.
# Changelog
## April 2024
- Added new `async_mode` option when creating on-us transfers
## March 2024
- Added `tradable_id` field to [List Customer
Trades](https://docs.jiko.io/reference) and [List Customer
Transactions](https://docs.jiko.io/reference) API endpoint.
- Added support for filtering by trade date to and from to [List Customer
Trades](https://docs.jiko.io/reference) and [List Customer
Transactions](https://docs.jiko.io/reference) API endpoints.
- Added support for filtering by types, timestamp_from and timestamp_to to
the [List Customer Transactions](https://docs.jiko.io/reference), [List
Account Transactions](https://docs.jiko.io/reference) API endpoints.
## February 2024
- Added support for filtering by status and direction to the [List ACH
Originations](https://docs.jiko.io/reference) API endpoint
- Added support for filtering by portal id and card id to the [List Customer
Transactions](https://docs.jiko.io/reference), [List Account
Transactions](https://docs.jiko.io/reference) API endpoints.
- Added support for filtering by status and direction to the [List ACH
Originations](https://docs.jiko.io/reference) API endpoint
- Added support for filtering by card status to the [List Account
Cards](https://docs.jiko.io/reference) endpoint.
- Added support for full withdrawals when performing on-us transfers by
using the new `amount` field.
- Added support for listing fees deducted when performing on-us transfers.
## January 2024
- Added [Get Health Check](https://docs.jiko.io/reference) API endpoint.
## December 2023
- Business Application additions:
- Added [Create Application](https://docs.jiko.io/reference) API endpoint.
- Added [Get Application](https://docs.jiko.io/reference) API endpoint.
- Added [Update Application](https://docs.jiko.io/reference) API endpoint.
- Added [Apply](https://docs.jiko.io/reference) API endpoint.
- Related Party Application additions:
- Added [List Related Party](https://docs.jiko.io/reference) API endpoint.
- Added [Create Related Party](https://docs.jiko.io/reference) API endpoint.
- Added [Delete Related Party](https://docs.jiko.io/reference) API endpoint.
- Added [Update Related Party](https://docs.jiko.io/reference) API endpoint.
- Document Upload additions:
- Added [List Document Requests](https://docs.jiko.io/reference) API endpoint.
- Added [Upload Document](https://docs.jiko.io/reference) API endpoint.
- Wire additions:
- Added [Create Wire](https://docs.jiko.io/reference) API endpoint.
## November 2023
- Added a new optional field `micro_deposit` to V1 `ACHCounterparty` model
that includes an indication of number of verification attempts for ACH
Counterparties verified via Micro Deposits
- Added [Close Portal](https://docs.jiko.io/reference) API endpoint.
- Added [Update Portal](https://docs.jiko.io/reference) API endpoint.
## October 2023
- Added enum value `PENDING` to the [Get Customer
Data](https://docs.jiko.io/reference) `account_status` field, signalling
that a customer has no open pocket.
## July 2023
- Added [Get Account Portal](https://docs.jiko.io/reference) API endpoint.
## May 2023
### 2023-05-26
- The response from uploading documents now includes a `document_id` field
for future reference.
### 2023-05-15
- Added [Create Portal](https://docs.jiko.io/reference) API endpoint.
- Added a new `category` type E-SIGN for the Electronic Communications
Disclosure Statement and Consent which was previously in the GENERAL
category.
### 2023-05-05
- Added a new `WIRE_COUNTERPARTY_VERIFICATION` document type.
- File size limits raised to 50 MB for files other than `ID_FRONT`,
`ID_BACK`, `SELFIE` and `PASSPORT` when uploading documents to a customer or
application.
- Updated documentation for both file upload endpoints.
## April 2023
### 2023-04-28
- Adds a new `category` field for agreements returned by the [List
Agreements](https://docs.jiko.io/reference) endpoint. This `category` field
groups all agreements into 3 categories, BANK, BROKERAGE, or GENERAL.
### 2023-04-19
- Added a new sandbox endpoint for simulating webhook calls, [Trigger
Webhook](https://docs.jiko.io/reference).
## March 2023
### 2023-03-30
- Added a new `yield_to_maturity` field to the `Trade` model.
### 2023-03-15
- Added a new `name` field to the `Portal` model.
## February 2023
### 2023-02-24
- Added a sandbox endpoint to fund accounts via ACH portals.
### 2023-02-16
- Added a new disclosure type, `FORM_CRS`, for Customer Relationship Summary
Forms.
### 2023-02-10
- Added `wire_fee_transaction` and `WIRE_FEE` transaction type to the [List
Customer Transactions](https://docs.jiko.io/reference), [List Account
Transactions](https://docs.jiko.io/reference) and [Get Account
Transaction](https://docs.jiko.io/reference) endpoints.
## January 2023
### 2023-01-25
- Added [Create On-Us Transfer](https://docs.jiko.io/reference) API
endpoint.
- Added [Get On-Us Transfer](https://docs.jiko.io/reference) API endpoint.
### 2023-01-18
- Added two optional filtering query parameters to the [List Customer
Statements](https://docs.jiko.io/reference) endpoint:
- The `type[]` query parameter makes it possible to filter by different types of statements, e.g. `?type[]=BANK&type[]=BROKERAGE`
- The `key` query parameter makes it possible to filter by either a specific month or a year, e.g. `?key=2023-01` or `?key=2022`
- Marked the [List Account Statements](https://docs.jiko.io/reference)
endpoint as deprecated. Please use the [List Customer
Statements](https://docs.jiko.io/reference) in future integrations.
### 2023-01-09
- Added a new transaction type and corresponding details object,
`on_us_transaction` to the response model in [List Customer
Transactions](https://docs.jiko.io/reference).
### 2023-01-06
- Added optional field `originally_onboarded_at` to request body in [Create
Application](https://docs.jiko.io/reference)
## November 2022
### 2022-11-09
- New counterparty type `WIRE` with a `wire` field, returned in [Get
Counterparty](https://docs.jiko.io/reference) and [List
Counterparties](https://docs.jiko.io/reference)
## September 2022
### 2022-09-28
- Added [List Customer Statements](https://docs.jiko.io/reference) API
endpoint.
### 2022-09-27
- Added [Get Customer Data](https://docs.jiko.io/reference) API endpoint.
### 2022-09-07
- Added [List Customer Trades](https://docs.jiko.io/reference) API endpoint.
- Added [List Customer Transactions](https://docs.jiko.io/reference) API
endpoint.
## August 2022
### 2022-08-29
- Added `name` field to the [List Customer
Accounts](https://docs.jiko.io/reference) and [Get Customer
Account](https://docs.jiko.io/reference) API endpoints
### 2022-08-16
- Added [Get Account Transaction](https://docs.jiko.io/reference) API
endpoint
### 2022-08-05
- Added [List ACH Originations](https://docs.jiko.io/reference) API endpoint
version: 1.29.0
x-api-status-urls: false
servers:
- description: Production server
url: https://{partner}.partner-api.jikoservices.com
- description: Sandbox server
url: https://{partner}.sandbox-api.jikoservices.com
tags:
- description: >
Use these endpoints to initiate, manage, and complete KYB for Businesses.
When an application has `status: “APPROVED”`, a
[Customer](https://docs.jiko.io/reference) is created for the Business.
Customers can have multiple [Accounts](https://docs.jiko.io/reference).
name: Businesses
- description: >
Use these endpoints to initiate, manage, and complete KYC for Individuals.
When an application has `status: “APPROVED”`, a
[Customer](https://docs.jiko.io/reference) is created for the Individual.
Customers can have multiple [Accounts](https://docs.jiko.io/reference).
name: Individuals
- description: >-
Use these endpoints to create and view Portals. Portals allow third-party
financial institutions to initiate ACH and wire transfers. A Portal
consists of a routing and an account number. A single portal is created by
default upon account creation.
name: Portals
- description: Use these endpoints to view and manage Card information.
name: Manage Cards
- description: >-
Use these endpoints to create, view, and manage Subscriptions.
Subscriptions provide Partners with the ability to subscribe to Events.
Once subscribed, Events will be sent to the specified URL.
name: Subscriptions
- description: Use these endpoints to initiate sandbox functionality.
name: Sandbox
- description: >
Use these endpoints to view Transactions of funds moving in and out of
Jiko Accounts, specifically the bank account component (cash deposits and
withdrawals). For viewing information regarding the brokerage account
component (buying and selling of T-bills), use
[Trades](https://docs.jiko.io/reference).
name: Transactions
- description: >-
Use these endpoints to view Trades, or transactions related to the buying
and selling of T-bills, within the brokerage account component of Jiko
Pockets.
name: Trades
- description: Use these endpoints to create, view, and manage ACH Transfers.
name: ACH
- description: Use these endpoints to create and view Counterparties using Plaid.
name: 'Counterparties: Plaid'
- description: Use these endpoints to create, view, and manage Physical Debit Cards.
name: Physical Cards
- description: Use these endpoints to create, view, and manage Virtual Debit Cards.
name: Virtual Cards
- description: >
Use these endpoints to view Account information. Jiko Accounts (also known
as Pockets) consist of a bank account and a brokerage account. When funds
are deposited into a Pocket, they’re immediately invested in T-bills.
</br>
In the API interface, the Account object encapsulates both accounts and
can be treated as a single account to deposit to or withdraw from.
name: Accounts
- description: Use these endpoints to view and manage personal details for a Customer.
name: Customers
- description: >-
Use these endpoints to retrieve monthly statements for bank and brokerage
accounts.
name: Statements
- description: >-
Use these endpoints to create and view On-Us (Book) Transfers between Jiko
accounts.
name: On-Us Transfers
- description: >
Use these endpoints to view Counterparties. Counterparties represent
external accounts when moving funds in or out of a Jiko Account. Jiko will
only transfer funds between accounts where the Counterparty has `status:
“VERIFIED”`, meaning ownership of the account has been confirmed.
name: Counterparties
- description: Use these endpoints to authenticate requests to the Jiko API.
name: Security
- description: Use these endpoints to view Events.
name: Events
- description: Use this endpoint to initiate Wire Transfers.
name: Wires
- description: Use these endpoints to setup automatic health checks for the Partner API.
name: Health
paths:
/health:
get:
tags:
- Health
summary: Get Health Check
operationId: Health_statusCheck
description: >-
A health check endpoint, which returns "OK" if the Partner API is up and
running.
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/HealthStatusCheckResponse'
/api/v1/customers/{customer_id}/jiko-accounts:
get:
tags:
- Accounts
summary: List Customer Accounts
operationId: Accounts_listCustomerAccounts
security:
- HTTPBearer: []
description: Get a list of all accounts for a specified customer.
parameters:
- required: true
schema:
title: Customer Id
type: string
format: uuid
name: customer_id
in: path
- required: false
schema:
title: Offset
type: integer
minimum: 0
default: 0
name: offset
in: query
- required: false
schema:
title: Limit
type: integer
maximum: 100
minimum: 1
default: 100
name: limit
in: query
- required: true
schema:
title: X-Jiko-Idempotency
type: string
format: uuid
name: x-jiko-idempotency
in: header
- required: true
schema:
title: X-Jiko-Signature
type: string
name: x-jiko-signature
in: header
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ListAccountsResponse'
example:
offset: 0
count: 1
items:
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08
name: J1 (4-week)
total_value:
value: 20708596
currency: USD
formatted: $207,085.96
status: OPEN
portfolio:
securities:
- description: US T-Bill
tradable_id: 4b955c69-dd95-4f6a-a0ff-325ee029f240
security_type: FIXED_INCOME
quantity: 2100
market_value:
value: 20708596
currency: USD
formatted: $207,085.96
external_id: 912796RF6
maturity_date: '2023-01-30'
yield_to_maturity: '0.0468'
ask: '98.628528'
bid: '98.612361'
cash:
value: 0
currency: USD
formatted: $0.00
all_time_earnings:
value: 935404
currency: USD
formatted: $9,354.04
object_type: Account
object_type: List
'404':
description: Not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/jiko-accounts/{account_id}:
get:
tags:
- Accounts
summary: Get Customer Account
operationId: Accounts_getSpecificAccount
security:
- HTTPBearer: []
description: Get a specific account.
parameters:
- required: true
schema:
title: Account Id
type: string
format: uuid
name: account_id
in: path
- required: true
schema:
title: X-Jiko-Idempotency
type: string
format: uuid
name: x-jiko-idempotency
in: header
- required: true
schema:
title: X-Jiko-Signature
type: string
name: x-jiko-signature
in: header
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Account'
example:
id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X
name: J1 (4-week)
total_value:
value: 20708596
currency: USD
formatted: $207,085.96
status: OPEN
portfolio:
securities:
- description: US T-Bill
tradable_id: 4b955c69-dd95-4f6a-a0ff-325ee029f240
security_type: FIXED_INCOME
quantity: 2100
market_value:
value: 20708596
currency: USD
formatted: $207,085.96
external_id: 912796RF6
maturity_date: '2023-01-30'
yield_to_maturity: '0.0468'
ask: '98.628528'
bid: '98.612361'
cash:
value: 0
currency: USD
formatted: $0.00
all_time_earnings:
value: 935404
currency: USD
formatted: $9,354.04
object_type: Account
'404':
description: Not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/customers/{customer_id}/transactions:
get:
tags:
- Transactions
summary: List Customer Transactions
operationId: Transactions_listCustomerTransactions
security:
- HTTPBearer: []
description: >-
Returns a list of transactions from a customer's **bank accounts**. It
does not include transactions between the **bank account** and
**brokerage account**.
parameters:
- required: true
schema:
title: Customer Id
type: string
format: uuid
name: customer_id
in: path
- description: Ordered by the transaction timestamp, descending by default.
required: false
schema:
$ref: '#/components/schemas/Order'
name: order
in: query
- required: false
schema:
title: Account[]
items:
type: string
format: uuid
type: array
name: account[]
in: query
- required: false
schema:
title: Filter[Card]
items:
type: string
format: uuid
type: array
name: filter[card]
in: query
- required: false
schema:
title: Filter[Portal]
items:
type: string
format: uuid
type: array
name: filter[portal]
in: query
- required: false
schema:
items:
$ref: '#/components/schemas/TransactionType'
type: array
name: filter[types]
in: query
- required: false
schema:
title: Timestamp From
type: string
format: date-time
name: timestamp_from
in: query
- required: false
schema:
title: Timestamp To
type: string
format: date-time
name: timestamp_to
in: query
- required: false
schema:
title: Cursor
type: string
default: ''
name: cursor
in: query
- required: false
schema:
title: Limit
type: integer
exclusiveMinimum: 0
default: 30
lte: 100
name: limit
in: query
- required: true
schema:
title: X-Jiko-Idempotency
type: string
format: uuid
name: x-jiko-idempotency
in: header
- required: true
schema:
title: X-Jiko-Signature
type: string
name: x-jiko-signature
in: header
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/TransactionListResponse'
example:
prev_page: >-
cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==
next_page: cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw
items:
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X
jiko_account_id: 8a7ec6c0-2701-40a1-8954-68870964b50d
amount:
value: 100000
currency: USD
formatted: $1,000.00
timestamp: '2023-01-01T12:00:00+00:00'
status: COMPLETED
details:
title: 'ATM ABCD ID: TERM99 at 26 HOUSTON TEXAS CIR, HOUSTON TX'
transaction_type: CARD
transaction_type_title: ATM Withdrawal
card_transaction:
location:
street_address: 26 HOUSTON TEXAS CIR
city: HOUSTON
state: TX
country: US
counterparty: ABCD
terminal_id: TERM99
merchant_type: ATM
pre_authorization: true
object_type: Transaction
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X
jiko_account_id: 8a7ec6c0-2701-40a1-8954-68870964b50d
amount:
value: 100000
currency: USD
formatted: $1,000.00
timestamp: '2023-01-01T12:00:00+00:00'
status: COMPLETED
details:
title: From VENMO (PAYMENT)
transaction_type: ACH
sub_title: 'IIN: 596425331 REF: 91000010211227'
transaction_type_title: ACH Electronic Debit
ach_transaction:
company_name: VENMO
company_entry_description: PAYMENT
individual_identification_number: '596425331'
trace_number: '091000010211227'
object_type: Transaction
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X
jiko_account_id: 8a7ec6c0-2701-40a1-8954-68870964b50d
amount:
value: 100000
currency: USD
formatted: $1,000.00
timestamp: '2023-01-01T12:00:00+00:00'
status: COMPLETED
details:
title: From External Account
transaction_type: WIRE
sub_title: 9999XXXX
transaction_type_title: Wire Transfer In
wire_transaction:
reference_number: 9999XXXX
counterparty_name: John Smith
wire_id: 4854014d-5540-4f0c-9efe-a0137f01e1da
object_type: Transaction
- id: 497f6eca-6276-4993-bfeb-53cbbbba6f08X
jiko_account_id: 8a7ec6c0-2701-40a1-8954-68870964b50d
amount:
value: 100000
currency: USD
formatted: $1,000.00
timestamp: '2023-01-01T12:00:00+00:00'
status: COMPLETED
details:
title: 2022-06 Card Cash Back
transaction_type: CASH_BACK
transaction_type_title: Card Cash Back
cash_back_transaction:
period: 2022-06
card_id: 66f6e46c-f6a1-4af8-a1bd-49666bc01301
object_type: Transaction
object_type: CursorList
'404':
description: Not found
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/jiko-accounts/{account_id}/transactions:
get:
tags:
- Transactions
summary: List Account Transactions
operationId: Transactions_listForAccount
security:
- HTTPBearer: []
description: >-
Returns a list of **bank account** transactions. It does not include
transactions between the **bank account** and **brokerage account**.
parameters:
- required: true
schema:
title: Account Id
type: string
format: uuid
name: account_id
in: path
- description: Ordered by the transaction timestamp, descending by default.
required: false
schema:
$ref: '#/components/schemas/Order'
name: order
in: query
- required: false
schema:
title: Filter[Card]
items:
type: string
format: uuid
type: array
name: filter[card]
in: query
- required: false
schema:
title: Filter[Portal]
items:
type: string
format: uuid
type: array
name: filter[portal]
in: query
- required: false
schema: