Skip to content

Jiko Partner API (Version: fd60d28d)

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. Use the Partner API if you are building an application that embeds Jiko’s services and offers Jiko products to your own customers. The Partner API will then enable your application to interact with Jiko on behalf of your customers.


At the core of our platform is the Jiko Pocket: a pair consisting of a bank account and a brokerage account. When money is deposited into a Pocket, 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 Pockets, and each Pocket is associated with a single T-bill maturity: 4-week, 13-week, 26-week or 52-week.


The API Reference covers everything you need to build a full application leveraging the Jiko platform:


  • Onboarding customers
  • Funding Pockets via ACH or Wire
  • Viewing and managing Pockets (including monthly statements and trade confirmations)
  • Making payments and transfers via ACH, Wire, On-Us (Book) Transfer or Debit Card

When you’re ready to start building, please contact us at partner.support@jiko.io to request sandbox access.

Download OpenAPI description
Languages
Servers
Production server
https://{partner}.partner-api.jikoservices.com
Sandbox server
https://{partner}.sandbox-api.jikoservices.com

Accounts

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.


In the API interface, the Account object encapsulates both accounts and can be treated as a single account to deposit to or withdraw from.

Operations

Customers

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

Operations

Transactions

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.

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 Customer Trades

Request

Returns a list of trades from a customer's brokerage accounts.

Security
HTTPBearer
Path
customer_idstring(uuid)(Customer Id)required
Query
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)
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:
orderstring(Order)

Ordered by the trade creation time, descending by default.

Default "desc"
Enum"desc""asc"
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v1/customers/{customer_id}/trades/?trade_datetime_from=2019-08-24T14%3A15%3A22Z&trade_datetime_to=2019-08-24T14%3A15%3A22Z&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&order=desc&limit=30' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

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": "cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==", "next_page": "cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw", "items": [ {} ], "object_type": "CursorList" }

List Account Trades

Request

Get a list of trades. This is the equivalent of fetching transactions for the brokerage account.

Security
HTTPBearer
Path
account_idstring(uuid)(Account Id)required
Query
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)
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)
orderstring(Order)

Ordered by the trade creation time, descending by default.

Default "desc"
Enum"desc""asc"
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v1/jiko-accounts/{account_id}/trades/?trade_datetime_from=2019-08-24T14%3A15%3A22Z&trade_datetime_to=2019-08-24T14%3A15%3A22Z&book_date_from=2019-08-24&book_date_to=2019-08-24&settlement_date_from=2019-08-24&settlement_date_to=2019-08-24&order=desc&limit=30' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

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": "cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==", "next_page": "cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw", "items": [ {} ], "object_type": "CursorList" }

Get Trade Confirmation

Request

Get a trade's trade confirmation.


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
HTTPBearer
Path
account_idstring(uuid)(Account Id)required
trade_idstring(uuid)(Trade Id)required
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v1/jiko-accounts/{account_id}/trades/{trade_id}/confirmation/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json
urlstring(uri)(Url)[ 1 .. 2083 ] charactersrequired
Example: "https://example.com/path-to-trade-confirmation-pdf"
object_typestring(Object Type)read-onlyrequired
Response
application/json
{ "url": "https://example.com/path-to-trade-confirmation-pdf" }

Statements

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

Operations

Manage Cards

Use these endpoints to view and manage Card information.

Operations

Physical Cards

Use these endpoints to create, view, and manage Physical Debit Cards.

Operations

Virtual Cards

Use these endpoints to create, view, and manage Virtual Debit Cards.

Operations

Businesses

Use these endpoints to initiate, manage, and complete KYB for Businesses. When an application has status: “APPROVED”, a Customer is created for the Business. Customers can have multiple Pockets.

Operations

Individuals

Use these endpoints to initiate, manage, and complete KYC for Individuals. When an application has status: “APPROVED”, a Customer is created for the Individual. Customers can have multiple Pockets.

Operations

Events

Use these endpoints to view Events.

Operations

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Sandbox

Use these endpoints to initiate sandbox functionality.

Operations

Security

Use these endpoints to authenticate requests to the Jiko API.

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

Webhooks

Webhooks

Reports

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

Use these endpoints to interact with Reports.

Operations

ACH

Use these endpoints to create, view, and manage ACH Transfers.

Operations

Counterparties

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

On-Us Transfers

Use these endpoints to create and view On-Us (Book) Transfers between Jiko accounts.

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

Wires

Use this endpoint to initiate Wire Transfers.

Operations

Pockets

Operations

Trading Strategies

Operations

Transactions V2

Operations

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Counterparties V2

Operations