Jiko Customer API (Version: fd60d28d)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude
Connect to Cursor
Install MCP server on Cursor
Connect to VS Code
Install MCP server on VS Code

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

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

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

Create Transfer Request

Request

This endpoint creates a new transfer request. This is the first step in a dual-control workflow for making transfers.

The request body requires a CreateTransferRequest object, which specifies the transfer details and the reviewers.

Security

CodeBearer

Bodyapplication/jsonrequired

transferany(Transfer)required

transfer.idstring(uuid)(Id)required

transfer.typeany(Type)required

Discriminator

Value "ON_US"

transfer.origin_pocket_idstring(uuid)(Origin Pocket Id)required

transfer.amountobject(CreateRequestedAmount)required

transfer.amount.typeany(Type)required

Value "REQUESTED_AMOUNT"

transfer.amount.amount_usdcinteger(Amount Usdc)> 0required

transfer.detailsCreatePeerToPeerTransfer (object) or CreateInternalReallocationTransfer (object)(Details)required

Any of:

transfer.details.typeany(Type)required

Value "PEER_TO_PEER"

transfer.details.destination_counterparty_idstring(uuid)(Destination Counterparty Id)required

transfer.descriptionDescription (string) or Description (null)(Description)

Any of:

<= 100 characters

string(Description)<= 100 characters

transfer.end_to_end_identificationEnd To End Identification (string) or End To End Identification (null)(End To End Identification)

Any of:

<= 35 characters

string(End To End Identification)<= 35 characters

reviewersArray of Reviewers (strings) or Reviewers (null)(Reviewers)

Any of:

curl -i -X POST \
  https://api.business.jiko.io/api/v1/transfer-requests/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "transfer": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "type": "WIRE",
      "origin_pocket_id": "e4c9f3a2-eafd-4d0a-97f0-9904e9909f97",
      "counterparty_id": "fd38dae9-b300-4017-a630-101c4279eafd",
      "amount": {
        "type": "REQUESTED_AMOUNT",
        "amount_usdc": 0
      },
      "description": "string"
    },
    "reviewers": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ]
  }'

Responses

Successful Response

Bodyapplication/json

any

Response

application/json

null

Get Transfer Requests

Request

This endpoint retrieves a list of transfer requests.

You can filter by status, reviewer, and other criteria, and returns a paginated list of TransferRequest objects.

Security

CodeBearer

Query

status_filter[]Array of Status Filter[] (strings) or Status Filter[] (null)(Status Filter[])

Any of:

reviewer_filter[]Array of Reviewer Filter[] (strings) or Reviewer Filter[] (null)(Reviewer Filter[])

Any of:

filter[]Array of Filter[] (strings) or Filter[] (null)(Filter[])

Example: filter[]=include_unassigned

Any of:

exclude_creator_filter[]Array of Exclude Creator Filter[] (strings) or Exclude Creator Filter[] (null)(Exclude Creator Filter[])

Any of:

cursorCursor (string) or Cursor (null)(Cursor)

Default ""

Any of:

string(Cursor)

Default ""

limitLimit (integer) or Limit (null)(Limit)

Default 30

Any of:

> 0

integer(Limit)> 0

Default 30

curl -i -X GET \
  'https://api.business.jiko.io/api/v1/transfer-requests/?status_filter%5B%5D=UNDER_REVIEW&reviewer_filter%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&filter%5B%5D=include_unassigned&exclude_creator_filter%5B%5D=497f6eca-6276-4993-bfeb-53cbbbba6f08&limit=30' \
  -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[].team_idstring(uuid)(Team Id)required

items[].created_by_userobject(DualAuthUser)required

items[].created_by_user.user_idstring(uuid)(User Id)required

items[].created_by_user.first_namestring(First Name)required

items[].created_by_user.last_namestring(Last Name)required

items[].created_by_user.activeboolean(Active)required

items[].created_by_user.rolestring(MakerChecker)required

Enum"MAKER""CHECKER""VIEWER"

items[].created_atstring(date-time)(Created At)required

items[].reviewed_by_userDualAuthUser (object) or null

Any of:

items[].reviewed_atReviewed At (string) or Reviewed At (null)(Reviewed At)

Any of:

string(date-time)(Reviewed At)

items[].denial_reasonDenialReason (string) or null

Any of:

string(DenialReason)

Enum"INCORRECT_AMOUNT""INCORRECT_PAYEE""OTHER"

items[].denial_other_memoDenial Other Memo (string) or Denial Other Memo (null)(Denial Other Memo)

Any of:

string(Denial Other Memo)

items[].statusstring(TransferRequestStatus)required

Enum"UNDER_REVIEW""APPROVED""PROCESSING""PROCESSED""REJECTED""CANCELED""DENIED"

items[].transferWireTransfer (object) or OnUsTransfer (object) or UsdcTransfer (object)(Transfer)required

Any of:

items[].transfer.idstring(uuid)(Id)required

items[].transfer.typeany(Type)required

Value "WIRE"

items[].transfer.counterparty_idstring(uuid)(Counterparty Id)required

items[].transfer.origin_pocket_idstring(uuid)(Origin Pocket Id)required

items[].transfer.amountobject(RequestedAmount)required

items[].transfer.amount.typeany(Type)required

Value "REQUESTED_AMOUNT"

items[].transfer.amount.amountobject(Amount)required

items[].transfer.amount.amount.valueinteger(Value)required

USD values are always in cents.

items[].transfer.amount.amount.currencystring(Currency)required

items[].transfer.amount.amount.formattedstring(Formatted)

Default ""

items[].transfer.descriptionDescription (string) or Description (null)(Description)

Any of:

string(Description)

items[].reviewersArray of objects(Reviewers)required

items[].reviewers[].user_idstring(uuid)(User Id)required

items[].reviewers[].first_namestring(First Name)required

items[].reviewers[].last_namestring(Last Name)required

items[].reviewers[].activeboolean(Active)required

items[].reviewers[].rolestring(MakerChecker)required

Enum"MAKER""CHECKER""VIEWER"

items[].reject_reasonRejectReason (string) or null

Any of:

string(RejectReason)

Enum"ACCOUNT_UNAVAILABLE""CANCELED""INSUFFICIENT_FUNDS""INVALID_CURRENCY""INVALID_TRANSFER""OTHER"

object_typestring(Object Type)

Default "CursorList"

Response

application/json

{
  "prev_page": "string",
  "next_page": "string",
  "items": [
    { … }
  ],
  "object_type": "CursorList"
}

Get Transfer Request Reviewers

Request

This endpoint retrieves a list of team members who are authorized to review transfer requests, and returns a list of DualAuthUser objects.

Security

CodeBearer

curl -i -X GET \
  https://api.business.jiko.io/api/v1/transfer-requests/reviewers/ \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [

user_idstring(uuid)(User Id)required

first_namestring(First Name)required

last_namestring(Last Name)required

activeboolean(Active)required

rolestring(MakerChecker)required

Enum"MAKER""CHECKER""VIEWER"

]

Response

application/json

[
  {
    "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
    "first_name": "string",
    "last_name": "string",
    "active": true,
    "role": "MAKER"
  }
]

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

Introduction

Agreements

Events

Notifications

Subscriptions

Reports

Statements

Team

Trades

Portals

Transfer Requests

Create Transfer Request

Request

Responses

Was this helpful?

Get Transfer Requests

Request

Responses

Was this helpful?

Get Transfer Request Reviewers

Request

Responses

Was this helpful?

Customer

User

Business Applications V2

Documents V2

Pockets V2

Transactions V2

Counterparties V2

Trading Strategies V2

Jiko Customer API (Version: fd60d28d)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from ClaudeConnect to CursorInstall MCP server on CursorConnect to VS CodeInstall MCP server on VS Code

Introduction

Agreements

Events

Notifications

Subscriptions

Reports

Statements

Team

Trades

Portals

Transfer Requests

Create Transfer Request

RequestExpand all

Responses

Was this helpful?

Get Transfer Requests

RequestExpand all

Responses

Was this helpful?

Get Transfer Request Reviewers

Request

Responses

Was this helpful?

Customer

User

Business Applications V2

Documents V2

Pockets V2

Transactions V2

Counterparties V2

Trading Strategies V2

Request

Request