Skip to content

Jiko Customer API (Version: fd60d28d)

Introduction

Welcome to the Jiko Customer API Reference! Jiko enables you to integrate money storage and movement, backed by the safety and security of US Treasury Bills. Use the Customer API if you are a Jiko customer integrating Jiko directly into your internal systems.

For questions regarding authorization for the Customer API, please visit our OAuth guide

Download OpenAPI description
Languages
Servers
Production server
https://api.business.jiko.io
Sandbox server
https://customer-api.sandbox-api.jikoservices.com

Agreements

Use this endpoint to fetch Agreements specific to your institution and Jiko.

Operations

Events

Use these endpoints to view Events.

Operations

Notifications

Use these endpoints for interacting with Notifications.

Operations

Subscriptions

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.

Operations

Reports

⚠️ Experimental ⚠️ These endpoints are subject to change.

Use these endpoints to interact with Reports.

Operations

Statements

Use these endpoints to retrieve monthly statements for bank and brokerage accounts.

Operations

Team

Use these endpoints to view and manage details for a Team and its members.

Operations

Trades

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.

Operations

Portals

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. Multiple Portals can be created for a single Pocket.

Operations

Transfer Requests

Use these endpoints to manage Dual Authorization for Tranfer Requests.

Operations

Customer

Use these endpoints to view and manage personal details for a Customer.

Operations

User

Use these endpoints to view User information.

Operations

Business Applications V2

Use this endpoint to view, create and manage Business Applications.

Operations

Documents V2

Use this endpoint to upload a document associated with a specific document ID. Useful for providing supporting documents for verification purposes.

Operations

Pockets V2

Use these endpoints to view Pocket information. Jiko Pockets consist of a bank account and a brokerage account. When funds are deposited into a Pocket, they're immediately invested in T-bills.

Operations

Transactions V2

Use these endpoints to view Transactions of funds moving in and out of Jiko Pockets, 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.

Operations

List Transactions

Request

This endpoint lists all transactions for a customer's pockets. It provides a comprehensive view of all financial activities.

It returns a paginated list of Transaction objects, which can be of various types (ACH, WIRE, CARD, etc.).

It does not include transactions between the bank account and brokerage account.

Security
CodeBearer
Query
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
orderstring(Order)
Default "desc"
Enum"desc""asc"
pocket[]Array of Pocket[] (strings) or Pocket[] (null)(Pocket[])
Any of:
type[]Array of Type[] (strings) or Type[] (null)(Type[])
Any of:
on_us_transfer[]Array of On Us Transfer[] (strings) or On Us Transfer[] (null)(On Us Transfer[])
Any of:
wire[]Array of Wire[] (strings) or Wire[] (null)(Wire[])
Any of:
time_booked_fromTime Booked From (string) or Time Booked From (null)(Time Booked From)
Any of:
string(date-time)(Time Booked From)
time_booked_toTime Booked To (string) or Time Booked To (null)(Time Booked To)
Any of:
string(date-time)(Time Booked To)
amount_toAmount To (integer) or Amount To (null)(Amount To)
Any of:
integer(Amount To)
amount_fromAmount From (integer) or Amount From (null)(Amount From)
Any of:
integer(Amount From)
directionDirection (string) or Direction (null)(Direction)
Any of:
string(Direction)
Enum"DEBIT""CREDIT"
curl -i -X GET \
  'https://api.business.jiko.io/api/v2/transactions/?limit=30&order=desc&pocket%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&type%5B%5D=ACH&on_us_transfer%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&wire%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&time_booked_from=2019-08-24T14%3A15%3A22Z&time_booked_to=2019-08-24T14%3A15%3A22Z&amount_to=0&amount_from=0&direction=DEBIT' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
prev_pagePrev Page (string) or Prev Page (null)(Prev Page)
Any of:
string(Prev Page)
next_pageNext Page (string) or Next Page (null)(Next Page)
Any of:
string(Next Page)
itemsArray of ACHTransactionActivity (object) or WireTransactionActivity (object) or CardTransactionActivity (object) or OnUsTransactionActivity (object) or FeeTransactionActivity (object) or CreditTransactionActivity (object) or GenericTransactionActivity (object)(Items)required
Any of:
items[].​idstring(uuid)(Id)required

The ID of the transaction from the perspective of the respective pocket

items[].​transaction_idstring(uuid)(Transaction Id)required

The ID of the transaction this activity is representing

items[].​descriptionstring(Description)required

A description of the transaction type, e.g. "ACH Electronic Debit".

items[].​amountobject(Amount)required
items[].​amount.​valueinteger(Value)required

USD values are always in cents.

items[].​amount.​currencystring(Currency)required
items[].​amount.​formattedstring(Formatted)
Default ""
items[].​time_bookedstring(date-time)(Time Booked)required

The time at which the transaction was originally booked into the ledger.

items[].​time_settledTime Settled (string) or Time Settled (null)(Time Settled)required

The time at which transaction was settled.

Any of:

The time at which transaction was settled.

string(date-time)(Time Settled)
items[].​statusstring(Status)required

Status of the transactions. Has the transactions been settled

Enum"BOOKED""SETTLED"
items[].​titlestring(Title)required
items[].​directionstring(Direction)required
Enum"DEBIT""CREDIT"
items[].​pocket_idstring(uuid)(Pocket Id)required

The pocket associated with the transaction

items[].​customer_idstring(uuid)(Customer Id)required

The customer associated with the transaction

items[].​remittance_informationRemittanceInformation (object) or null
Any of:
items[].​typeany(Type)required
Value "ACH"
items[].​company_namestring(Company Name)required
items[].​company_entry_descriptionCompany Entry Description (string) or Company Entry Description (null)(Company Entry Description)
Any of:
string(Company Entry Description)
items[].​individual_identification_numberIndividual Identification Number (string) or Individual Identification Number (null)(Individual Identification Number)
Any of:
string(Individual Identification Number)
items[].​trace_numberTrace Number (string) or Trace Number (null)(Trace Number)
Any of:
string(Trace Number)
items[].​ach_idAch Id (string) or Ach Id (null)(Ach Id)
Any of:
string(uuid)(Ach Id)
items[].​ach_directionstring(ACHDirection)required
Enum"RECEIVING""ORIGINATION"
items[].​portal_idPortal Id (string) or Portal Id (null)(Portal Id)
Any of:
string(uuid)(Portal Id)
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{ "prev_page": "string", "next_page": "string", "items": [ {} ], "object_type": "CursorList" }

Transactions As Csv

Request

This endpoint downloads a customer's transaction history in CSV format. This is useful for accounting and reconciliation purposes, and can be filtered by pocket, transaction type, and a time range.

Security
CodeBearer
Query
pocket[]Array of Pocket[] (strings) or Pocket[] (null)(Pocket[])
Any of:
type[]Array of Type[] (strings) or Type[] (null)(Type[])
Any of:
time_booked_fromTime Booked From (string) or Time Booked From (null)(Time Booked From)
Any of:
string(date-time)(Time Booked From)
time_booked_toTime Booked To (string) or Time Booked To (null)(Time Booked To)
Any of:
string(date-time)(Time Booked To)
curl -i -X GET \
  'https://api.business.jiko.io/api/v2/transactions.csv?pocket%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&type%5B%5D=ACH&time_booked_from=2019-08-24T14%3A15%3A22Z&time_booked_to=2019-08-24T14%3A15%3A22Z' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Response
No content

Counterparties V2

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.

Operations

Trading Strategies V2

Use these endpoints to see available trading strategies applicable to a Pocket.

Operations