Successful Response
Jiko Partner API (Version: fd60d28d)
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.
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.
Request
Get a list of all accounts for a specified customer. Deprecated: Use List Pockets for Customer instead.
- Production serverhttps://your-partner-name.partner-api.jikoservices.com/api/v1/customers/{customer_id}/jiko-accounts/
- Sandbox serverhttps://your-partner-name.sandbox-api.jikoservices.com/api/v1/customers/{customer_id}/jiko-accounts/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Customer accounts
Current total value of account
Total liquid cash and holdings
Securities currently held by the brokerage account
The current market value of the securities
Due date of the fixed income instrument
Rate of return if the security is held to the maturity date
The current price the account is willing to sell the security at
The current price the market is willing to pay for the security
Cash currently held in the brokerage account.
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.
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.
{ "offset": 0, "count": 1, "items": [ { … } ], "object_type": "List" }
Request
Get a specific account. Deprecated: Use Get Customer Pocket instead.
- Production serverhttps://your-partner-name.partner-api.jikoservices.com/api/v1/jiko-accounts/{account_id}/
- Sandbox serverhttps://your-partner-name.sandbox-api.jikoservices.com/api/v1/jiko-accounts/{account_id}/
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
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'Successful Response
Current total value of account
Total liquid cash and holdings
Securities currently held by the brokerage account
The current market value of the securities
Due date of the fixed income instrument
Rate of return if the security is held to the maturity date
The current price the account is willing to sell the security at
The current price the market is willing to pay for the security
Cash currently held in the brokerage account.
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.
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.
{ "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" }
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.
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.