The Accounts API allows you to retrieve account and transaction data for Citi Customers who have authorized your app. In most cases, you'll want to request a summary of all accounts first, which will return basic account information and accountIds. Once you have this information, you can request additional account details and/or transactions.

Note: The Developer Hub Sandbox is a test environment that allows you to make API calls that are the same in form and function to our production environments. It contains mock test data so that you can prototype your application as if it were the real thing. When you’re finished testing, contact sales to request production access.

,

Note: Skip this step if you already created an app and have a pair of Client ID and Client Secret.

  1. Sign in to developer.citi.com
  2. Select My Applications tab.
  3. Click Register a New App
     

a. Fill out the required details

b. Upload an icon for your app (optional)

c. Click Submit

d. You will receive a pair of Client ID and Client Secret. Store this information securely. Use the Show button/checkbox to see your Client ID and Client Secret.

Note: Client secret is shown only once, so make sure you save this information. If in any case you lose your credential set, you can use the Regenerate button to get a new set of Client ID & Client Secret.

,

An access token is required to call all functional APIs. To retrieve your access token, visit your market’s Authorize guide.

,

Returns a summary of all accounts held by a Citi customer who has authorized your application. If a customer has multiple but similar accounts, e.g. two savings accounts, the accounts will be returned in the array accountGroupSummary.

Sample Request:

 

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

nextStartIndex

 

 

,

Returns additional account details than what is provided in the summary of all accounts. To retrieve the details, simply pass the accountId returned to you from the account summary.

Sample Request:

 

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

accountId

674d4a4f6a443741656e5a584a6f57665a444e685772393273615777397a4c665073305a5a2b51356f76513d

,

Returns an array of transactions for the specified account. For investment transactions such as buying or selling a stock, they will be returned in the array investmentTransaction.

Sample Request:

 

Parameters

Value

Authorization

Bearer <<Authorization Token>>

uuid

8120e2d6-0381-4e52-9d90-a5bf771ff243

Accept

application/json

Client_ID

e5245bed-daaf-4eac-867b-57a564604fda

accountId

674d4a4f6a443741656e5a584a6f57665a444e685772393273615777397a4c665073305a5a2b51356f76513d

transactionStatus

 

nextStartIndex

 

requestSize

 

transactionFromDate

 

transactionToDate

 

amountFrom

 

amountTo