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

List Trades

Request

This endpoint lists all buy, sell, and maturity events for securities (T-bills) within the customer's accounts.

Returns a paginated TradeListResponse. The list can be filtered by account and a trade datetime range.

Security
CodeBearer
Query
book_date_fromBook Date From (string) or Book Date From (null)(Book Date From)

Filters the resulting trade list by book date from the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by book date from the provided ISO8601 date, inclusively

string(date)(Book Date From)
book_date_toBook Date To (string) or Book Date To (null)(Book Date To)

Filters the resulting trade list by book date to the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by book date to the provided ISO8601 date, inclusively

string(date)(Book Date To)
settlement_date_fromSettlement Date From (string) or Settlement Date From (null)(Settlement Date From)

Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively

string(date)(Settlement Date From)
settlement_date_toSettlement Date To (string) or Settlement Date To (null)(Settlement Date To)

Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively

string(date)(Settlement Date To)
account[]Array of Account[] (strings) or Account[] (null)(Account[])
Any of:
trade_datetime_fromTrade Datetime From (string) or Trade Datetime From (null)(Trade Datetime From)
Any of:
string(date-time)(Trade Datetime From)
trade_datetime_toTrade Datetime To (string) or Trade Datetime To (null)(Trade Datetime To)
Any of:
string(date-time)(Trade Datetime To)
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/trades/?book_date_from=2019-08-24&book_date_to=2019-08-24&settlement_date_from=2019-08-24&settlement_date_to=2019-08-24&account%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&trade_datetime_from=2019-08-24T14%3A15%3A22Z&trade_datetime_to=2019-08-24T14%3A15%3A22Z&limit=30' \
  -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 objects(Items)required
items[].​idstring(uuid)(Id)required
items[].​trade_datetimestring(date-time)(Trade Datetime)required
items[].​settled_dateSettled Date (string) or Settled Date (null)(Settled Date)required
Any of:
string(date)(Settled Date)
items[].​is_settledboolean(Is Settled)required
items[].​activitystring(Activity)required
Enum"BUY""SELL""MATURITY"
items[].​cusipstring(Cusip)required
items[].​descriptionstring(Description)required
items[].​notionalobject(Amount)required
items[].​notional.​valueinteger(Value)required

USD values are always in cents.

items[].​notional.​currencystring(Currency)required
items[].​notional.​formattedstring(Formatted)
Default ""
items[].​quantityinteger(Quantity)required
items[].​pricestring(Decimal)required
items[].​maturity_datestring(date)(Maturity Date)required
items[].​jiko_account_idstring(uuid)(Jiko Account Id)required
items[].​yield_to_maturitystring(Decimal)required
items[].​tradable_idstring(Tradable Id)required
items[].​book_datestring(date)(Book Date)required
items[].​object_typestring(Object Type)read-onlyrequired
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{ "prev_page": "string", "next_page": "string", "items": [ {} ], "object_type": "CursorList" }

Trades As Csv

Request

This endpoint downloads the customer's complete trade history as a CSV file.

This is useful for record-keeping and analysis and can be filtered by account and a trade datetime range.

Security
CodeBearer
Query
book_date_fromBook Date From (string) or Book Date From (null)(Book Date From)

Filters the resulting trade list by book date from the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by book date from the provided ISO8601 date, inclusively

string(date)(Book Date From)
book_date_toBook Date To (string) or Book Date To (null)(Book Date To)

Filters the resulting trade list by book date to the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by book date to the provided ISO8601 date, inclusively

string(date)(Book Date To)
settlement_date_fromSettlement Date From (string) or Settlement Date From (null)(Settlement Date From)

Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by settlement date from the provided ISO8601 date, inclusively

string(date)(Settlement Date From)
settlement_date_toSettlement Date To (string) or Settlement Date To (null)(Settlement Date To)

Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively

Any of:

Filters the resulting trade list by settlement date to the provided ISO8601 date, inclusively

string(date)(Settlement Date To)
account[]Array of Account[] (strings) or Account[] (null)(Account[])
Any of:
trade_datetime_fromTrade Datetime From (string) or Trade Datetime From (null)(Trade Datetime From)
Any of:
string(date-time)(Trade Datetime From)
trade_datetime_toTrade Datetime To (string) or Trade Datetime To (null)(Trade Datetime To)
Any of:
string(date-time)(Trade Datetime To)
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/trades.csv?book_date_from=2019-08-24&book_date_to=2019-08-24&settlement_date_from=2019-08-24&settlement_date_to=2019-08-24&account%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&trade_datetime_from=2019-08-24T14%3A15%3A22Z&trade_datetime_to=2019-08-24T14%3A15%3A22Z' \
  -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 objects(Items)required
items[].​idstring(uuid)(Id)required
items[].​trade_datetimestring(date-time)(Trade Datetime)required
items[].​settled_dateSettled Date (string) or Settled Date (null)(Settled Date)required
Any of:
string(date)(Settled Date)
items[].​is_settledboolean(Is Settled)required
items[].​activitystring(Activity)required
Enum"BUY""SELL""MATURITY"
items[].​cusipstring(Cusip)required
items[].​descriptionstring(Description)required
items[].​notionalobject(Amount)required
items[].​notional.​valueinteger(Value)required

USD values are always in cents.

items[].​notional.​currencystring(Currency)required
items[].​notional.​formattedstring(Formatted)
Default ""
items[].​quantityinteger(Quantity)required
items[].​pricestring(Decimal)required
items[].​maturity_datestring(date)(Maturity Date)required
items[].​jiko_account_idstring(uuid)(Jiko Account Id)required
items[].​yield_to_maturitystring(Decimal)required
items[].​tradable_idstring(Tradable Id)required
items[].​book_datestring(date)(Book Date)required
items[].​object_typestring(Object Type)read-onlyrequired
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{ "prev_page": "string", "next_page": "string", "items": [ {} ], "object_type": "CursorList" }

Download Trade Confirmation

Request

This endpoint downloads the confirmation for a specific trade, and returns a 307 Temporary Redirect to the trade confirmation PDF location.

Trade confirmations are sensitive documents. For security reasons, we return trade confirmations as PDFs through a URL with a 10-minute TTL.

Trade confirmation PDFs should be fetched and served just-in-time, not stored in databases.

Trades with "activity": "MATURITY" do not have trade confirmations.

Security
CodeBearer
Path
trade_idstring(uuid)(Trade Id)required
account_idstring(uuid)(Account Id)required
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/accounts/{account_id}/trades/{trade_id}/confirmation/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Response
No content

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

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