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

List Account Portals

Request

This endpoint lists the payment portals associated with a specific Jiko account ID. Portals provide account and routing numbers for receiving funds into an account.

Returns a ListPortalsResponse object containing a list of Portal objects.

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

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
portalsArray of objects(Portals)>= 0 itemsrequired
portals[].​idstring(uuid)(Id)required
portals[].​jiko_account_idstring(uuid)(Jiko Account Id)required
portals[].​routing_numberstring(Routing Number)required

Routing number

portals[].​account_numberstring(Account Number)required

Account number

portals[].​statusstring(Status)required

Portal status

Enum"OPEN""CLOSED"
portals[].​namestring(Name)<= 50 charactersrequired

Portal name

portals[].​payment_railsArray of strings(Payment Rails)required

Specifies which payment rails (ACH, WIRE, ON_US) are accepted.

Items Enum"ACH""WIRE""ON_US"
portals[].​object_typestring(Object Type)read-onlyrequired
object_typestring(Object Type)
Default "List"
Response
application/json
{ "count": 0, "portals": [ {} ], "object_type": "List" }

List Customer Portals

Request

This endpoint lists all portals for the customer. It returns a ListPortalsResponse object containing a list of Portal objects.

Security
CodeBearer
curl -i -X GET \
  https://api.business.jiko.io/api/v1/portals/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
countinteger(Count)required
portalsArray of objects(Portals)>= 0 itemsrequired
portals[].​idstring(uuid)(Id)required
portals[].​jiko_account_idstring(uuid)(Jiko Account Id)required
portals[].​routing_numberstring(Routing Number)required

Routing number

portals[].​account_numberstring(Account Number)required

Account number

portals[].​statusstring(Status)required

Portal status

Enum"OPEN""CLOSED"
portals[].​namestring(Name)<= 50 charactersrequired

Portal name

portals[].​payment_railsArray of strings(Payment Rails)required

Specifies which payment rails (ACH, WIRE, ON_US) are accepted.

Items Enum"ACH""WIRE""ON_US"
portals[].​object_typestring(Object Type)read-onlyrequired
object_typestring(Object Type)
Default "List"
Response
application/json
{ "count": 0, "portals": [ {} ], "object_type": "List" }

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