Accounts

Overview

The Accounts API is designed to allow you to access basic account details, balances, and transactions for your company’s Citi and non-Citi bank accounts.

The Accounts API can retrieve:

1. Account Details of all accounts linked to the client initiating the request, such as branch code and currency, and other information,
2. Account Balances, either: Intraday (during the day specific period) or End of day,
3. and Account Transactions for one account.

---

What will this help me with?

Cash Positioning — View your real-time consolidated financial position right from your application.

Transaction Management — Up-to-date account transaction details helps manage cash flow, bank transaction reconciliation and expenses.

Enhanced Forecasting — Improve the accuracy of cash flow forecasting by using the most current information. This helps in planning for future cash needs, managing working capital, and setting more accurate financial targets.

---

How it works

You are encouraged to use Authentication v4 for this API which requires only one SSL certificate but can use Authentication v3 for this API if preferred.

All API responses are designed to be paginated to ensure you can retrieve all necessary data. To limit the amount of personally identifiable data being shared, the Accounts API also generates Accounts Aliases to be used in all subsequent API calls.

To GET Account Details

To GET Account Balances

The balance returned for a given request will depend on several factors:

• The time of day in the local market where the account is setup
• The local currency; balances are returned in the local currency
• The local market and branch operating hours, cutoff and processing period.

To GET Account Transactions

---

Availability

Formats

• JSON
• XML

Countries

Available in any country where Citi operates. Please speak with your Citi Representative for additional details.

Intraday vs. End of Day balances

• If no transaction has occurred during a day, then the End of Day balance would be available
• The intraday balance is available when 1 transaction has occurred on the account

Branch operating hours and balances

Balance availability is determined by the branch operating hours. As an example, branch hours in Hong Kong and the United Kingdom are not the same hours due to their respective time zones.

Cut-off and processing periods

• Each branch has a cut-off and processing period. Transactions occurring during this time will appear during the following available intraday or end of day balance
• Local branch hours determine when the cut-off and processing periods start. For most branches, the cut-off and processing periods start after the branch or local clearing has closed for the day
• Branch and API requestor in the same time zone
• Accounts in more than one time zone
• Each branch has a cut-off and processing period where the balance information will not be available for a couple of hours
• Local branch hours determine when this cut-off and processing period will commence. As an example, most of these will occur after the branch or local clearing has closed
• If the system calling the Balance data is in another time zone from the account location, then the system design must cater for the account location cut-off period and branch hours
• When the cut-off period has been reached, no intraday balance would be available
• However, the end of day balance would be available, but the request must be for the previous day

---

Security requirements

Citi uses access tokens to authenticate and authorize API requests from your application. To receive an access token from Citi you will first send an API request to our OAuth endpoint using your API credentials: client ID and secret key. Please visit the Authentication guide for more details.

You are encouraged to use Authentication v4 for the Accounts API, but you can use Authentication v3 for this API if preferred.