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

List Customer AccountsDeprecated

Request

Get a list of all accounts for a specified customer. Deprecated: Use List Pockets for Customer instead.

Security
HTTPBearer
Path
customer_idstring(uuid)(Customer Id)required
Query
offsetinteger(Offset)>= 0
Default 0
limitinteger(Limit)[ 1 .. 100 ]
Default 100
omit[]Array of Omit[] (strings) or Omit[] (null)(Omit[])
Any of:
unique
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}/jiko-accounts/?offset=0&limit=100&omit%5B%5D=ALL_TIME_EARNINGS' \
  -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
offsetinteger(Offset)required
countinteger(Count)required
itemsArray of objects(Items)required

Customer accounts

items[].​idstring(uuid)(Id)required
items[].​namestring(Name)required

The account name

items[].​total_valueobject(Amount)required

Current total value of account

items[].​total_value.​valueinteger(Value)required

USD values are always in cents.

items[].​total_value.​currencystring(Currency)required
items[].​total_value.​formattedstring(Formatted)
Default ""
items[].​statusstring(Status)required

Account status

Enum"OPEN""CLOSED""FROZEN"
items[].​portfolioobject(Portfolio)required

Total liquid cash and holdings

items[].​portfolio.​securitiesArray of objects(Securities)required

Securities currently held by the brokerage account

items[].​portfolio.​securities[].​tradable_idstring(uuid)(Tradable Id)required
items[].​portfolio.​securities[].​security_typestring(Security Type)required
Enum"FIXED_INCOME""OTHER"
items[].​portfolio.​securities[].​quantityinteger(Quantity)> 0required

Number of securities

items[].​portfolio.​securities[].​market_valueobject(Amount)required

The current market value of the securities

items[].​portfolio.​securities[].​market_value.​valueinteger(Value)required

USD values are always in cents.

items[].​portfolio.​securities[].​market_value.​currencystring(Currency)required
items[].​portfolio.​securities[].​market_value.​formattedstring(Formatted)
Default ""
items[].​portfolio.​securities[].​external_idstring(External Id)required
items[].​portfolio.​securities[].​maturity_datestring(date)(Maturity Date)required

Due date of the fixed income instrument

items[].​portfolio.​securities[].​yield_to_maturitystring(Decimal)required

Rate of return if the security is held to the maturity date

items[].​portfolio.​securities[].​askstring(Decimal)required

The current price the account is willing to sell the security at

items[].​portfolio.​securities[].​bidstring(Decimal)required

The current price the market is willing to pay for the security

items[].​portfolio.​securities[].​descriptionstring(Description)required

A description of the security

items[].​portfolio.​cashobject(Amount)required

Cash currently held in the brokerage account.

items[].​portfolio.​cash.​valueinteger(Value)required

USD values are always in cents.

items[].​portfolio.​cash.​currencystring(Currency)required
items[].​portfolio.​cash.​formattedstring(Formatted)
Default ""
items[].​portfolio.​all_time_earningsAmount (object) or nullrequired

All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the Get Earnings endpoint instead.

Any of:

All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the Get Earnings endpoint instead.

items[].​portfolio.​all_time_earnings.​valueinteger(Value)required

USD values are always in cents.

items[].​portfolio.​all_time_earnings.​currencystring(Currency)required
items[].​portfolio.​all_time_earnings.​formattedstring(Formatted)
Default ""
items[].​object_typestring(Object Type)read-onlyrequired
object_typestring(Object Type)
Default "List"
Response
application/json
{ "offset": 0, "count": 1, "items": [ {} ], "object_type": "List" }

Get Customer AccountDeprecated

Request

Get a specific account. Deprecated: Use Get Customer Pocket instead.

Security
HTTPBearer
Path
account_idstring(uuid)(Account Id)required
Query
omit[]Array of Omit[] (strings) or Omit[] (null)(Omit[])
Any of:
unique
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}/?omit%5B%5D=ALL_TIME_EARNINGS' \
  -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
idstring(uuid)(Id)required
namestring(Name)required

The account name

total_valueobject(Amount)required

Current total value of account

total_value.​valueinteger(Value)required

USD values are always in cents.

total_value.​currencystring(Currency)required
total_value.​formattedstring(Formatted)
Default ""
statusstring(Status)required

Account status

Enum"OPEN""CLOSED""FROZEN"
portfolioobject(Portfolio)required

Total liquid cash and holdings

portfolio.​securitiesArray of objects(Securities)required

Securities currently held by the brokerage account

portfolio.​securities[].​tradable_idstring(uuid)(Tradable Id)required
portfolio.​securities[].​security_typestring(Security Type)required
Enum"FIXED_INCOME""OTHER"
portfolio.​securities[].​quantityinteger(Quantity)> 0required

Number of securities

portfolio.​securities[].​market_valueobject(Amount)required

The current market value of the securities

portfolio.​securities[].​market_value.​valueinteger(Value)required

USD values are always in cents.

portfolio.​securities[].​market_value.​currencystring(Currency)required
portfolio.​securities[].​market_value.​formattedstring(Formatted)
Default ""
portfolio.​securities[].​external_idstring(External Id)required
portfolio.​securities[].​maturity_datestring(date)(Maturity Date)required

Due date of the fixed income instrument

portfolio.​securities[].​yield_to_maturitystring(Decimal)required

Rate of return if the security is held to the maturity date

portfolio.​securities[].​askstring(Decimal)required

The current price the account is willing to sell the security at

portfolio.​securities[].​bidstring(Decimal)required

The current price the market is willing to pay for the security

portfolio.​securities[].​descriptionstring(Description)required

A description of the security

portfolio.​cashobject(Amount)required

Cash currently held in the brokerage account.

portfolio.​cash.​valueinteger(Value)required

USD values are always in cents.

portfolio.​cash.​currencystring(Currency)required
portfolio.​cash.​formattedstring(Formatted)
Default ""
portfolio.​all_time_earningsAmount (object) or nullrequired

All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the Get Earnings endpoint instead.

Any of:

All time portfolio earnings. Use of this field is discouraged, as it will be removed in a future release. Please use the Get Earnings endpoint instead.

portfolio.​all_time_earnings.​valueinteger(Value)required

USD values are always in cents.

portfolio.​all_time_earnings.​currencystring(Currency)required
portfolio.​all_time_earnings.​formattedstring(Formatted)
Default ""
object_typestring(Object Type)read-onlyrequired
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "J1 (4-week)", "total_value": { "value": 20708596, "currency": "USD", "formatted": "$207,085.96" }, "status": "OPEN", "portfolio": { "securities": [], "cash": {}, "all_time_earnings": {} }, "object_type": "Account" }

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

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