Skip to content

Jiko Partner API (Version: fd60d28d)

Introduction

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.

Download OpenAPI description
Languages
Servers
Production server
https://{partner}.partner-api.jikoservices.com
Sandbox server
https://{partner}.sandbox-api.jikoservices.com

Accounts

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.

Operations

Customers

Use these endpoints to view and manage personal details for a Customer.

Operations

Transactions

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.

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

Statements

Use these endpoints to retrieve monthly statements for bank and brokerage accounts.

Operations

Manage Cards

Use these endpoints to view and manage Card information.

Operations

Physical Cards

Use these endpoints to create, view, and manage Physical Debit Cards.

Operations

Virtual Cards

Use these endpoints to create, view, and manage Virtual Debit Cards.

Operations

Businesses

Use these endpoints to initiate, manage, and complete KYB for Businesses. When an application has status: “APPROVED”, a Customer is created for the Business. Customers can have multiple Pockets.

Operations

Individuals

Use these endpoints to initiate, manage, and complete KYC for Individuals. When an application has status: “APPROVED”, a Customer is created for the Individual. Customers can have multiple Pockets.

Operations

Events

Use these endpoints to view Events.

Operations

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Sandbox

Use these endpoints to initiate sandbox functionality.

Operations

Security

Use these endpoints to authenticate requests to the Jiko API.

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

Webhooks

Webhooks

Reports

⚠️ Experimental ⚠️ These endpoints are subject to change.

Use these endpoints to interact with Reports.

Operations

ACH

Use these endpoints to create, view, and manage ACH Transfers.

Operations

Counterparties

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

On-Us Transfers

Use these endpoints to create and view On-Us (Book) Transfers between Jiko accounts.

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

Wires

Use this endpoint to initiate Wire Transfers.

Operations

Pockets

Operations

Trading Strategies

Operations

Transactions V2

Operations

List Partner Transactions

Request

Returns a list of pocket transactions. It does not include transactions between the bank account and brokerage account.

Security
HTTPBearer
Query
cursorstring(Cursor)
Default ""
limitinteger(Limit)> 0
Default 30
orderstring(Order)
Default "desc"
Enum"desc""asc"
directionDirection (string) or Direction (null)(Direction)
Any of:
string(Direction)
Enum"DEBIT""CREDIT"
amount_fromAmount From (integer) or Amount From (null)(Amount From)
Any of:
integer(Amount From)
amount_toAmount To (integer) or Amount To (null)(Amount To)
Any of:
integer(Amount To)
filter[card]Array of Filter[Card] (strings) or Filter[Card] (null)(Filter[Card])
Any of:
filter[portal]Array of Filter[Portal] (strings) or Filter[Portal] (null)(Filter[Portal])
Any of:
filter[type]Array of Filter[Type] (strings) or Filter[Type] (null)(Filter[Type])
Any of:
filter[on_us_transfer]Array of Filter[On Us Transfer] (strings) or Filter[On Us Transfer] (null)(Filter[On Us Transfer])
Any of:
filter[wire]Array of Filter[Wire] (strings) or Filter[Wire] (null)(Filter[Wire])
Any of:
time_booked_fromTime Booked From (string) or Time Booked From (null)(Time Booked From)
Any of:
string(date-time)(Time Booked From)
time_booked_toTime Booked To (string) or Time Booked To (null)(Time Booked To)
Any of:
string(date-time)(Time Booked To)
time_settled_fromTime Settled From (string) or Time Settled From (null)(Time Settled From)
Any of:
string(date-time)(Time Settled From)
time_settled_toTime Settled To (string) or Time Settled To (null)(Time Settled To)
Any of:
string(date-time)(Time Settled To)
include_sweepsInclude Sweeps (boolean) or Include Sweeps (null)(Include Sweeps)
Any of:
boolean(Include Sweeps)
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v2/transactions/?limit=30&order=desc&direction=DEBIT&amount_from=0&amount_to=0&filter%5Bcard%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter%5Bportal%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter%5Btype%5D=ACH&filter%5Bon_us_transfer%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter%5Bwire%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&time_booked_from=2019-08-24T14%3A15%3A22Z&time_booked_to=2019-08-24T14%3A15%3A22Z&time_settled_from=2019-08-24T14%3A15%3A22Z&time_settled_to=2019-08-24T14%3A15%3A22Z&include_sweeps=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

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 ACHTransactionActivity (object) or WireTransactionActivity (object) or CardTransactionActivity (object) or OnUsTransactionActivity (object) or FeeTransactionActivity (object) or CreditTransactionActivity (object) or GenericTransactionActivity (object)(Items)required
Any of:
items[].​idstring(uuid)(Id)required

The ID of the transaction from the perspective of the respective pocket

items[].​transaction_idstring(uuid)(Transaction Id)required

The ID of the transaction this activity is representing

items[].​descriptionstring(Description)required

A description of the transaction type, e.g. "ACH Electronic Debit".

items[].​amountobject(Amount)required
items[].​amount.​valueinteger(Value)required

USD values are always in cents.

items[].​amount.​currencystring(Currency)required
items[].​amount.​formattedstring(Formatted)
Default ""
items[].​time_bookedstring(date-time)(Time Booked)required

The time at which the transaction was originally booked into the ledger.

items[].​time_settledTime Settled (string) or Time Settled (null)(Time Settled)required

The time at which transaction was settled.

Any of:

The time at which transaction was settled.

string(date-time)(Time Settled)
items[].​statusstring(Status)required

Status of the transactions. Has the transactions been settled

Enum"BOOKED""SETTLED"
items[].​titlestring(Title)required
items[].​directionstring(Direction)required
Enum"DEBIT""CREDIT"
items[].​pocket_idstring(uuid)(Pocket Id)required

The pocket associated with the transaction

items[].​customer_idstring(uuid)(Customer Id)required

The customer associated with the transaction

items[].​remittance_informationRemittanceInformation (object) or null
Any of:
items[].​typeany(Type)required
Value "ACH"
items[].​company_namestring(Company Name)required
items[].​company_entry_descriptionCompany Entry Description (string) or Company Entry Description (null)(Company Entry Description)
Any of:
string(Company Entry Description)
items[].​individual_identification_numberIndividual Identification Number (string) or Individual Identification Number (null)(Individual Identification Number)
Any of:
string(Individual Identification Number)
items[].​trace_numberTrace Number (string) or Trace Number (null)(Trace Number)
Any of:
string(Trace Number)
items[].​ach_idAch Id (string) or Ach Id (null)(Ach Id)
Any of:
string(uuid)(Ach Id)
items[].​ach_directionstring(ACHDirection)required
Enum"RECEIVING""ORIGINATION"
items[].​portal_idPortal Id (string) or Portal Id (null)(Portal Id)
Any of:
string(uuid)(Portal Id)
object_typestring(Object Type)
Default "CursorList"
Response
application/json
{ "prev_page": "cj0xJnA9MjAyMi0xMi0yMSsxNyUzQTIyJTNBMDguNjc5MzQ5JTJCMDAlM0EwMA==", "next_page": "cD0yMDIyLTEyLTE5KzE5JTNBNTQlM0EyNy4xODMyNzglMkIwMCUzQTAw", "items": [ {} ], "object_type": "CursorList" }

Get Transaction

Request

Retrieves a single transaction activity by ID. A transaction activity represents a single side (debit/credit) of a transaction.

Security
HTTPBearer
Path
transaction_activity_idstring(uuid)(Transaction Activity Id)required
Headers
x-jiko-idempotencystring(uuid)(X-Jiko-Idempotency)required
x-jiko-signaturestring(X-Jiko-Signature)required
curl -i -X GET \
  'https://your-partner-name.partner-api.jikoservices.com/api/v2/transactions/{transaction_activity_id}/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-jiko-idempotency: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'x-jiko-signature: string'

Responses

Successful Response

Bodyapplication/json
idstring(uuid)(Id)required

The ID of the transaction from the perspective of the respective pocket

transaction_idstring(uuid)(Transaction Id)required

The ID of the transaction this activity is representing

descriptionstring(Description)required

A description of the transaction type, e.g. "ACH Electronic Debit".

amountobject(Amount)required
amount.​valueinteger(Value)required

USD values are always in cents.

amount.​currencystring(Currency)required
amount.​formattedstring(Formatted)
Default ""
time_bookedstring(date-time)(Time Booked)required

The time at which the transaction was originally booked into the ledger.

time_settledTime Settled (string) or Time Settled (null)(Time Settled)required

The time at which transaction was settled.

Any of:

The time at which transaction was settled.

string(date-time)(Time Settled)
statusstring(Status)required

Status of the transactions. Has the transactions been settled

Enum"BOOKED""SETTLED"
titlestring(Title)required
directionstring(Direction)required
Enum"DEBIT""CREDIT"
pocket_idstring(uuid)(Pocket Id)required

The pocket associated with the transaction

customer_idstring(uuid)(Customer Id)required

The customer associated with the transaction

remittance_informationRemittanceInformation (object) or null
Any of:
typeany(Type)required
Discriminator
Value "ACH"
company_namestring(Company Name)required
company_entry_descriptionCompany Entry Description (string) or Company Entry Description (null)(Company Entry Description)
Any of:
string(Company Entry Description)
individual_identification_numberIndividual Identification Number (string) or Individual Identification Number (null)(Individual Identification Number)
Any of:
string(Individual Identification Number)
trace_numberTrace Number (string) or Trace Number (null)(Trace Number)
Any of:
string(Trace Number)
ach_idAch Id (string) or Ach Id (null)(Ach Id)
Any of:
string(uuid)(Ach Id)
ach_directionstring(ACHDirection)required
Enum"RECEIVING""ORIGINATION"
portal_idPortal Id (string) or Portal Id (null)(Portal Id)
Any of:
string(uuid)(Portal Id)
Response
application/json
{ "id": "05964326-49b7-4e74-9783-81137ee3cf3b", "transaction_id": "4b955c69-dd95-4f6a-a0ff-325ee029f240", "description": "Wire Transfer In", "amount": { "value": 100000, "currency": "USD", "formatted": "$1,000.00" }, "time_booked": "2023-01-01T12:00:00Z", "time_settled": "2023-01-02T12:00:00Z", "status": "SETTLED", "title": "From External Account", "direction": "DEBIT", "pocket_id": "8a7ec6c0-2701-40a1-8954-68870964b50d", "customer_id": "66f6e46c-f6a1-4af8-a1bd-49666bc01301", "type": "WIRE", "reference_number": "9999XXXX", "counterparty_name": "John Smith", "wire_id": "4854014d-5540-4f0c-9efe-a0137f01e1da" }

Health

Use these endpoints to setup automatic health checks for the Partner API.

Operations

Counterparties V2

Operations