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

Create Customer Report RequestExperimental

Request

This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:

Type BANK_STATEMENT_REPORT

End-of-day bank statement for the pocket’s bank account, exported in ISO 20022 camt.053 format. Transactions reported in this statement include fund deposits and withdrawals, incoming and outgoing third-party payments (when applicable), fees, automated sweep transactions between the pocket’s bank account and its linked brokerage account.

Note: since Jiko automatically sweeps funds between the bank account and the associated brokerage account in the pocket, the bank account’s end-of-day balance is always 0. To report on balances held with Jiko, we invite you to use:

  • Either the Brokerage statement, to import the value of held T-bills in the cash position of your treasury management system, reported as the closing balance of an account,

  • or the Trade report, to import individual buy and sell transactions into your treasury management system and derive the corresponding position.

Valid output_formats values: CAMT053.

Type BROKERAGE_STATEMENT_REPORT

End-of-day statement for the pocket’s brokerage account, exported in ISO 20022 camt.053 format. With the opening value and closing value of the T-bills held in the pocket on the selected reporting date, represented as the account balance. Values are based on end-of-day market prices, or on the current market price if the report is generated before day-end.

The statement also includes the following records that explain the change between the opening and closing values:

  • Additions: new funds deposited into the brokerage account.

  • Subtractions: funds withdrawn from the brokerage account.

  • Gains/Losses from T-bills held in the account.

  • Fees charged and deducted from the brokerage account.

Valid output_formats values: CAMT053.

Type TRADE_REPORT

List of T-bill buy & sell trades within a user-defined range of trade dates, exported in CSV format. Each trade in the file includes three categories of information:

  • Security master data: CUSIP, issuer, issue date, maturity date.

  • Trading entity parameters: transaction code, custodian details.

  • Trade details: buy/sell indicator, trade date, price, amount, reference.

The date ranges filter has a maximum range of 31 days. Optionally, the date range filter can be configured to be based on either settlement dates, or book dates.

Valid output_formats values: KYRIBA_CSV, CSV.

Type SECURITY_PRICE_REPORT

End-of-day security prices within a user-defined range of dates, exported in CSV format. With:

  • An “SE” field identifying the entry as a security price.

  • The name of the price provider: “JIKO”.

  • The CUSIP of the security.

  • The pricing date.

  • The end-of-day price.

Valid output_formats values: KYRIBA_CSV.

Type POSITION_SUMMARY_REPORT

Provides a snapshot of holdings as of a user-selected date, showing CUSIP-level positions by pocket along with associated cash values. The report includes the following key fields: Pocket, CUSIP, Quantity, Market Price, Market Value, and Historical Cost Value. Customers use this report to export pocket-level valuations to downstream systems and to reconcile imported buy and sell transactions against the quantities reflected in the Position Summary

Valid output_formats values: PDF, CSV.

Security
CodeBearer
Bodyapplication/jsonrequired
idstring(uuid)(Id)required
reportBankStatementReport (object) or TradeReport (object) or SecurityPriceReport (object) or BrokerageStatementReport (object) or PositionSummaryReport (object)(Report)required
Any of:
report.​pocket_idsArray of strings(uuid)(Pocket Ids)required
report.​datestring(date)(Date)required
report.​typeany(Type)required
Value "BANK_STATEMENT_REPORT"
output_formatsArray of Output Formats (strings) or Output Formats (null)(Output Formats)

If specified, renders only the specified formats. If not specified, renders all the available formats for the given report. The available formats differ depending on the report being requested. For a description of what formats are available per report, please refer to the Create Report Request endpoint description.

Any of:

If specified, renders only the specified formats. If not specified, renders all the available formats for the given report. The available formats differ depending on the report being requested. For a description of what formats are available per report, please refer to the Create Report Request endpoint description.

[ 1 .. 20 ] items
curl -i -X POST \
  https://api.business.jiko.io/api/v1/report-requests/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "report": {
      "pocket_ids": [
        "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      ],
      "date": "2019-08-24",
      "type": "BANK_STATEMENT_REPORT"
    },
    "output_formats": [
      "string"
    ]
  }'

Responses

Successful Response

Response
No content

List Customer Report RequestsExperimental

Request

This endpoint lists all report request for a customer. You can filter by date from and to

It returns a paginated list of ReportRequest objects.

Security
CodeBearer
Query
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
date_fromDate From (string) or Date From (null)(Date From)
Any of:
string(date-time)(Date From)
date_toDate To (string) or Date To (null)(Date To)
Any of:
string(date-time)(Date To)
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/report-requests/?limit=30&date_from=2019-08-24T14%3A15%3A22Z&date_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[].​typestring(Type)required
items[].​metadataMetadata (object) or Metadata (null)(Metadata)required
Any of:
object(Metadata)
items[].​created_atstring(date-time)(Created At)required
items[].​reportsArray of objects(Reports)required
items[].​reports[].​idstring(uuid)(Id)required
items[].​reports[].​file_namestring(File Name)required
items[].​reports[].​mime_typestring(Mime Type)required
items[].​reports[].​statusstring(Status)required
Enum"PENDING""AVAILABLE""FAILED"
items[].​reports[].​typestring(Type)required
items[].​reports[].​metadataMetadata (object) or Metadata (null)(Metadata)required
Any of:
object(Metadata)
items[].​reports[].​created_atstring(date-time)(Created At)required
items[].​reports[].​formatReportFormat (object) or null
Any of:
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{ "prev_page": "string", "next_page": "string", "items": [ {} ], "object_type": "CursorList" }

Get Customer Report RequestExperimental

Request

This endpoint retrieves the details of a specific report request, and returns a single ReportRequest object.

Security
CodeBearer
Path
report_request_idstring(uuid)(Report Request Id)required
curl -i -X GET \
  'https://api.business.jiko.io/api/v1/report-requests/{report_request_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required
typestring(Type)required
metadataMetadata (object) or Metadata (null)(Metadata)required
Any of:
object(Metadata)
created_atstring(date-time)(Created At)required
reportsArray of objects(Reports)required
reports[].​idstring(uuid)(Id)required
reports[].​file_namestring(File Name)required
reports[].​mime_typestring(Mime Type)required
reports[].​statusstring(Status)required
Enum"PENDING""AVAILABLE""FAILED"
reports[].​typestring(Type)required
reports[].​metadataMetadata (object) or Metadata (null)(Metadata)required
Any of:
object(Metadata)
reports[].​created_atstring(date-time)(Created At)required
reports[].​formatReportFormat (object) or null
Any of:
Response
application/json
{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "metadata": {}, "created_at": "2019-08-24T14:15:22Z", "reports": [ {} ] }

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