Customer Accounts Summary and Details

Accounts

Customer Accounts Summary and Details

A convenient and user-friendly experience so that customers can retrieve their account and transaction data. Customers can view the information of all of their accounts along with the account details. They can request both, the summary of all accounts to get the basic account information and account IDs as well as additional accounts and transactions details.

Australia

Hong Kong

India

Indonesia

Malaysia

Philippines

Poland

Singapore

Thailand

United Kingdom

Api's Called

Accounts

Aggregate your Citi account details into a third-party application

Using the Authorize and Accounts APIs, customers can choose to connect their Citi accounts such as credit and savings to a third-party application of their choice.
Zoom In

Identify Yourself Securely

In order to enable the connection of the customer's Citi accounts to the third-party application, the customer is prompted with a modal window (triggered by the OAuth API) where they are asked to login to their Citi account in order to verify their identity.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization Code Grant: Retrieve Authorization Code

This API gets invoked by a web browser redirection and requires user interaction. It is used to retrieve an authorization code by redirecting the user to a login page followed by the consent approval page. At the end of this flow, this endpoint returns to the redirect_uri configured for the associated application.

Endpoint

Australia: GET /authCode/oauth2/authorize

India: GET /authCode/oauth2/authorize

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Customers validate the One Time PIN (OTP) sent to their registered mobile number

Customers validate the OTP sent to their registered mobile number. In the three-legged OAuth flow, OTP validation is based on a fraud and risk recommendation, which is not mandatory.
Zoom In

Customer Consent

Customers are then presented with Citi’s consent page where they can read the Terms and Conditions of what account information will and will not be shared with the third-party application. If they agree, the customers click ‘Authorize'.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Retrieve access token

Get an access token issued by calling our token endpoint and passing the authorization code from the previous call. The issued access token will have an expiry, and it will be valid only for the scope for which the consent has been provided by the customer. You can call the APIs by passing this token in Authorization header.

You also get a refresh token that can be used to get a new access token in case the original one expires.

Endpoint

Australia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Singapore: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Hong Kong: POST /authCode/oauth2/token/<countryCode>/<businessCode>

India:  POST /authCode/oauth2/token/<countryCode>/<businessCode>

Indonesia : POST /authCode/oauth2/token/<countryCode>/<businessCode>

Malaysia: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Philippines: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Thailand: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Poland:POST /authCode/oauth2/token/<countryCode>/<businessCode>

UK: POST /authCode/oauth2/token/<countryCode>/<businessCode>

Parameters

PATH

NA

Query

response_type

client_id

scope

countryCode

businessCode

locale

state

redirect_uri

Refresh Access Token

If the access token has expired and the partner still has a valid refresh token, they can refresh customer’s access token by calling the Refresh Token API and can exchange it for a new set of valid access and refresh tokens.

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Refresh access token 

This API generates a fresh access token. If your access token has expired and you still have a valid refresh token, you can exchange it for a new set of valid access and refresh tokens. 

End Point

Australia: POST /authCode/oauth2/refresh

Singapore: POST /authCode/oauth2/refresh

Hong Kong: POST /authCode/oauth2/refresh

India: POST /authCode/oauth2/refresh

Indonesia: POST /authCode/oauth2/refresh

Malaysia: POST /authCode/oauth2/refresh

Philippines: POST /authCode/oauth2/refresh

Thailand: POST /authCode/oauth2/refresh

Poland: POST /authCode/oauth2/refresh

UK: POST /authCode/oauth2/refresh

Parameters

PATH

NA

FormData

grant_type

refresh_token

Revoke Access Token

This API is used to revoke the access token and the corresponding refresh token. 

After successful revocation, the tokens are marked invalid and customer needs to register again to access the APIs.

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Authorization code grant: Revoke access token

This API is used to revoke the access token and requires the resource owner to pass the valid client credentials, a valid token and the token type as inputs. Along with the access token, the corresponding refresh token is also revoked and vice-versa.

End Point

Australia: POST /authCode/oauth2/revoke

Singapore: POST /authCode/oauth2/revoke

Hong Kong: POST /authCode/oauth2/revoke

India: POST /authCode/oauth2/revoke

Indonesia: POST /authCode/oauth2/revoke

Malaysia: POST /authCode/oauth2/revoke

Philippines: POST /authCode/oauth2/revoke

Thailand: POST /authCode/oauth2/revoke

Poland: POST /authCode/oauth2/revoke

UK: POST /authCode/oauth2/revoke

Parameters

PATH

NA

FormData

token

token_type_hint

Customer Account Summary

Customers can retrieve the summary of several account types held by them, such as their savings accounts, loan accounts and credit card accounts, which they will see populated in the screens of the third-party application.

 

There is a variation in API callouts for aggregators and cobrand partners. Please refer as applicable.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve summary of all accounts - For Aggregators

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.

Endpoint

Australia: GET /v1/accounts

Singapore: GET /v1/accounts

Hong Kong: GET /v1/accounts

India: GET /v1/accounts

Indonesia : GET /v1/accounts

Malaysia: GET /v1/accounts

Philippines: GET /v1/accounts

Thailand: GET /v1/accounts

Poland: GET /v1/accounts

UK: GET /v1/accounts

 

Parameters

PATH

NA

View Api Callout 2 >
×

Use Case Callout

Retrieve summary of all accounts - For Cobrand Partners

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.

Endpoint

Australia: GET /partner/v1/partnerAccounts  

Singapore: GET /partner/v1/partnerAccounts  

Hong Kong: GET /partner/v1/partnerAccounts  

India: GET /partner/v1/partnerAccounts  

Indonesia : GET /partner/v1/partnerAccounts  

Malaysia: GET /partner/v1/partnerAccounts  

Philippines: GET /partner/v1/partnerAccounts  

Thailand: GET /partner/v1/partnerAccounts  

 

Parameters

PATH

NA

Savings Accounts Listing of Customer

Customers can see the list of various savings accounts held by them. Account information is displayed, which includes fields like amount deposited, current balance after the deposit and total current balance for all the savings accounts after the deposit.
Zoom In

Loan Accounts Listing of Customer

Customers can see the list of various loan accounts held by them like housing or educational loans. Account information is displayed which includes fields like available credit limit, current balance for each loan account along with the total outstanding credit amount for all the loan accounts.
Zoom In

Credit Card Accounts Listing of Customer

Customers can see the list of various credit card accounts held by them like Cash Back Card and Citi Prestige Card. Account wise detailed information is displayed which includes fields like available credit limit, current balance for each credit card account along with the total credit amount used against all the available credit cards.
Zoom In

View Account Details

Customers can see a detailed view of various accounts held by them. For instance, for the Citi Prestige Card they can see fields like available credit, credit limit amount, current balance, minimum payment, date when the last statement was generated, last payment date and amount, as well as last statement balance and payment due date.

Customers can also check their transaction history by clicking on the link View Transaction history.

Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve account details

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.

Endpoint

Australia: GET /v1/accounts/{accountId}

Singapore: GET /v1/accounts/{accountId}

Hong Kong: GET /v1/accounts/{accountId}

India: GET /v1/accounts/{accountId}

Indonesia: GET /v1/accounts/{accountId}

Malaysia: GET /v1/accounts/{accountId}

Philippines: GET /v1/accounts/{accountId}

Thailand: GET /v1/accounts/{accountId}

Poland: GET /v1/accounts/{accountId}

UK: GET /v1/accounts/{accountId}

Parameters

PATH

accountId

Select the date range and transaction type

Customers view their transaction history by providing the date range and transaction type like all, billed, unbilled and pending.

For credit cards, the customers can retrieve transaction history for the last 12 months with the restriction of 90 days for the date range. For all other cards and account types, transaction history for the last 12 months can be retrieved with no date range criteria.

Zoom In

View Transaction History

Customers can see the detailed transaction history and analyze their spending pattern. They can see information like transaction remarks, transaction date and the credit or debit amount for these transactions.
Zoom In

API(s) Callout

View Api Callout 1 >
×

Use Case Callout

Retrieve Transactions

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.

Endpoint

Australia: GET /v1/accounts/{accountId}/transactions

Singapore: GET /v1/accounts/{accountId}/transactions}

Hong Kong: GET /v1/accounts/{accountId}/transactions

India: GET /v1/accounts/{accountId}/transactions

Indonesia: GET /v1/accounts/{accountId}/transactions

Malaysia: GET /v1/accounts/{accountId}/transactions

Philippines: GET /v1/accounts/{accountId}/transactions

Thailand: GET /v1/accounts/{accountId}/transactions

Poland: GET /v1/accounts/{accountId}/transactions

UK: GET /v1/accounts/{accountId}/transactions

Parameters

PATH

accountId

Query

transactionStatus

nextStartIndex

requestSize

transactionFromDate

transactionToDate

amountFrom

amountTo