Use this endpoint to fetch Agreements specific to your institution and Jiko.
Jiko Customer API (Version: fd60d28d)
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
Request
This endpoint triggers an asynchronous process to create a report request based on the provided parameters. Available report types are:
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.
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.
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.
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.
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.
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.
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.
- Production serverhttps://api.business.jiko.io/api/v1/report-requests/
- Sandbox serverhttps://customer-api.sandbox-api.jikoservices.com/api/v1/report-requests/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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"
]
}'- Production serverhttps://api.business.jiko.io/api/v1/report-requests/
- Sandbox serverhttps://customer-api.sandbox-api.jikoservices.com/api/v1/report-requests/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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>'{ "prev_page": "string", "next_page": "string", "items": [ { … } ], "object_type": "CursorList" }
- Production serverhttps://api.business.jiko.io/api/v1/report-requests/{report_request_id}/
- Sandbox serverhttps://customer-api.sandbox-api.jikoservices.com/api/v1/report-requests/{report_request_id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.business.jiko.io/api/v1/report-requests/{report_request_id}/' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "metadata": {}, "created_at": "2019-08-24T14:15:22Z", "reports": [ { … } ] }
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.
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.