Skip to content
/Notifications

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
reference.json
reference.yaml
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

List Notifications

Request

This endpoint lists all notifications for a customer. You can filter by status (READ or UNREAD).

It returns a paginated list of CustomerNotification objects.

Security
CodeBearer
Query
statusNotificationStatus (string) or Status (null)(Status)
Any of:
string(NotificationStatus)
Enum"READ""UNREAD"
cursorstring(Cursor)
Default ""
limitinteger(Limit)[ 1 .. 100 ]
Default 100
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/notifications/?status=READ&limit=100' \
  -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[].​descriptionstring(Description)required
items[].​statusNotificationStatus (string) or nullrequired
Any of:
string(NotificationStatus)
Enum"READ""UNREAD"
items[].​titlestring(Title)required
items[].​typestring(Type)required
items[].​created_atstring(date-time)(Created At)required
items[].​notification_metadataNotification Metadata (object) or Notification Metadata (null)(Notification Metadata)
Any of:
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{
  "prev_page": "string",
  "next_page": "string",
  "items": [
    { … }
  ],
  "object_type": "CursorList"
}

Get Notification

Request

This endpoint retrieves a single notification by its notification_id, and returns a CustomerNotification object.

Security
CodeBearer
Path
notification_idstring(uuid)(Notification Id)required
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/notifications/{notification_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
descriptionstring(Description)required
statusNotificationStatus (string) or nullrequired
Any of:
string(NotificationStatus)
Enum"READ""UNREAD"
titlestring(Title)required
typestring(Type)required
created_atstring(date-time)(Created At)required
notification_metadataNotification Metadata (object) or Notification Metadata (null)(Notification Metadata)
Any of:
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "description": "string",
  "status": "READ",
  "title": "string",
  "type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "notification_metadata": {
    "property1": "string",
    "property2": "string"
  }
}

Patch Notification

Request

This endpoint allows you to update the status of a notification, for example, to mark it as read.

The request body must contain an UpdateCustomerNotificationStatus object. It returns the updated CustomerNotification object.

Security
CodeBearer
Path
notification_idstring(uuid)(Notification Id)required
Bodyapplication/jsonrequired
statusstring(NotificationStatus)required
Enum"READ""UNREAD"
curl -i -X PATCH \
  'https://api.business.jiko.io/api/v1/notifications/{notification_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "status": "READ"
  }'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
descriptionstring(Description)required
statusNotificationStatus (string) or nullrequired
Any of:
string(NotificationStatus)
Enum"READ""UNREAD"
titlestring(Title)required
typestring(Type)required
created_atstring(date-time)(Created At)required
notification_metadataNotification Metadata (object) or Notification Metadata (null)(Notification Metadata)
Any of:
Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "description": "string",
  "status": "READ",
  "title": "string",
  "type": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "notification_metadata": {
    "property1": "string",
    "property2": "string"
  }
}

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

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

© 2026 Jiko Technologies, Inc. All rights reserved.